Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[add] gh-pages script and update README #40

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kesquerra
Copy link
Contributor

  • Adds gh-pages script that:
    • creates gh-pages branch if it doesn't exist
    • checkouts existing or new branch
    • deletes root level README.md
    • updates .gitignore to remove *.zip (mvnw scm:publish pushes .zip files)
    • commits changes to gh-pages branch
    • checkouts main and runs:
      • mvnw site
      • mvnw site:stage
      • mvnw scm-publish:publish-scm
  • Update README.md to reflect *.zip changes in .gitignore

@kesquerra kesquerra changed the title add gh-pages script and update README [add] gh-pages script and update README Jun 25, 2022
@DavidWhitlock
Copy link
Collaborator

I want to think on this one some more before I determine whether or not I want to merge it. I'm not sure if I want to hide the details of creating the gh-pages branch from the students.

@kesquerra
Copy link
Contributor Author

kesquerra commented Jun 29, 2022

I did remove the commit that deletes the instructions in the readme to setup the gh-pages branch.
Now that I think about it, the script might be better suited to check that gh-pages is setup correctly and then run the maven processes, or else notify user of changes to be made.
This might even be better suited for a workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants