-
Notifications
You must be signed in to change notification settings - Fork 411
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
auto-update documented version for external projects #1169
Conversation
3dca688
to
1a27477
Compare
Testing:
Testing with old code:
|
1a27477
to
ca6396b
Compare
go install ./cmd/ipfs | ||
cd $ROOT/docs/reference | ||
./generate-cli-docs.sh | ||
fi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: github doesn't detect the move so it looks like I created the whole file. This PR really "just" move the update version code lower and calls it thrice.
-
We also push to a unique branch on file changes, instead of something like
new-documentation-${NEW_TAG}
because documentation updates are not only tied to go-ipfs versions anymore. -
I was thinking about extracting the version replace script to its own action, but I'm under the impression that would make the code more complex (spread it around 3 actions instead of a single script file).
uses: repo-sync/pull-request@65194d8015be7624d231796ddee1cd52a5023cb3 #v2.16 | ||
if: ${{ steps.update.outputs.updated_branch }} | ||
- name: pull-request | ||
uses: repo-sync/pull-request@65785d95a5a466e46a9d0708933a3bd51bbf9dde #v2.6.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I started seeing a workspace error (https://github.com/laurentsenta/ipfs-docs/runs/6756806053?check_suite_focus=true) in my github action, had to update. I think the previous version was a typo (2.6.1, not 16)
ca6396b
to
f318871
Compare
f318871
to
efac06e
Compare
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @laurentsenta ❤️
LGTM (/releases/latest
skips release candidates, and only shows final releases, which is what we want).
Let's merge this (if there are any issues, we can improve in follow-up PR)
update_version ipfs/ipfs-update current-ipfs-updater-version | ||
update_version ipfs/ipfs-cluster current-ipfs-cluster-version | ||
update_version ipfs/go-ipfs current-ipfs-version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@johnnymatthews for now we track updates of these three, but if we ever add more projects, we can add them here with ease (as long they are on github and publish releases there)
Fixes #1128
Todo
jq