Skip to content

Commit 84c2e61

Browse files
committed
Update post-generation message to only mention selecting GH Pages source
1 parent 900991d commit 84c2e61

1 file changed

Lines changed: 5 additions & 12 deletions

File tree

hooks/post_gen_project.py

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,12 @@ def main(initialise_git_repository: str, deploy_docs_to_github_pages: str) -> in
8686
return _EXIT_FAILURE
8787
if deploy_docs_to_github_pages == "True":
8888
print(
89-
"The 'Documentation' GitHub Actions workflow has been set up to push the "
90-
"built HTML documentation to a branch gh-pages on pushes to main for "
91-
"deploying as a GitHub Pages website. To allow the GitHub Actions bot to "
92-
"push to the gh-pages branch you need to enable 'Read and write "
93-
"permissions' under 'Workflow permissions' at\n\n"
94-
"{{cookiecutter.__repo_url}}/settings/actions\n\n"
95-
"After the 'Documentation' workflow has successfully completed at least "
96-
"once you will also need to configure the repository to deploy a GitHub "
97-
"pages site from the content on the gh-pages branch by going to\n\n"
89+
"The 'Documentation' GitHub Actions workflow has been set up to deploy the "
90+
"built HTML documentation to a GitHub Pages website on pushes to main. \n\n"
91+
"You will need to configure the repository to deploy a GitHub pages site "
92+
"using GitHub Actions by going to\n\n"
9893
"{{cookiecutter.__repo_url}}/settings/pages\n\n"
99-
"and under 'Built and deployment' selecting 'Deploy from a branch' for "
100-
"the 'Source' drop-down and 'gh-pages' for the 'Branch' drop-down, "
101-
"leaving the branch path drop-down with its default value of '/ (root)'."
94+
"and under 'Build and deployment' selecting 'GitHub Actions' for 'Source'."
10295
)
10396

10497
return _EXIT_SUCCESS

0 commit comments

Comments
 (0)