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.

Sign up for GitHub

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

Jump to bottom

[Snack] Version the docs #301

Merged
merged 2 commits into from
Jan 14, 2021
Merged

[Snack] Version the docs #301

merged 2 commits into from
Jan 14, 2021

Conversation

jack-r-warren
Copy link
Contributor

Purpose

  • Ed mentioned that it is weird that we don't version docs at all, I think it is a good point

Changes

  • Enabled "keep_files" on our GH Pages deploy action so it doesn't delete things not replicated in the last build, because...
  • ...release actions now deploy the docs into a subfolder, so https://broadinstitute.github.io/wfl/v0.5.0 or whatever
  • No one would know about that link so now we add a note to the release here
    • While we're at it, inject the most recent changelog section into those notes
  • TL;DR: current docs stay the same, but now we also get versioned docs linked to from the release for free

Review Instructions

  • I had a touch of free time and figured I might be able to tackle this. Just an idea, not beholden to it at all

@jack-r-warren
Make normal doc updates not trample other files it sees...
4cd9a40
@jack-r-warren
Make release process put docs in subfolder and add release
8601ea2 
The magic sed command on line 178 is doing the following:
1. Skip the first line (it is a header)
2. Print everything that isn't a header
3. Quit at the next header
rexwangcc
rexwangcc reviewed Jan 14, 2021
View reviewed changes
.github/workflows/release_latest_version.yml
Docs available at [broadinstitute.github.io/wfl/${{ steps.version.outputs.VERSION }}](https://broadinstitute.github.io/wfl/${{ steps.version.outputs.VERSION }})

[Changes](https://github.com/broadinstitute/wfl/blob/${{ steps.version.outputs.VERSION }}/CHANGELOG.md):
${{ steps.version.outputs.CHANGELOG }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is this step of Action will create a separate git tag for the docs, in addition to what make_git_tag in cli.py created?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The create-release action here only makes a tag if one doesn't already exist (see how commitish here is unused if the tag already exists). The action here is like if we went to the releases page ourselves and made a release from an existing tag.

Tags are already present on the releases page anyway, this just formalizes it so we can add some description text

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Thanks for the explanation!

@jack-r-warren jack-r-warren merged commit 7969998 into main Jan 14, 2021
@jack-r-warren jack-r-warren deleted the jack-r-warren/snack/version-the-docs branch January 14, 2021 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rexwangcc rexwangcc rexwangcc approved these changes

@ehigham ehigham Awaiting requested review from ehigham

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jack-r-warren @rexwangcc