-
Notifications
You must be signed in to change notification settings - Fork 302
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 automatic version updater script and github action #2359
Conversation
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.
Looks good except the miner/vx.x.x
regex issue
nodes/full-nodes/basic-setup.md
Outdated
@@ -12,14 +12,14 @@ To install Lotus on your computer, follow these steps: | |||
2. Once you have downloaded the binary file, extract the contents to a directory of your choice. For example, if you are using Linux, you can extract the contents to the `/usr/local/bin directory` by running the command: | |||
|
|||
```sh | |||
sudo tar -C /usr/local/bin -xzf lotus-X.X.X-linux-amd64.tar.gz | |||
sudo tar -C /usr/local/bin -xzf lotus-1.31.3-linux-amd64.tar.gz | |||
``` | |||
|
|||
3. Replace `X.X.X` with the version number of the release you downloaded. |
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.
We can remove the instructions to substitute the X.X.X
for the version number, same below as well.
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.
done!
Can we also add a test on all PRs that fails if the current version in the docs matches the current version in the lotus repo? That way we'll know when it gets out of date. |
…rsion without lotus prefix, removed instructions that include X.X.X
Great idea! We can change the github action to run on every open PR? |
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.
LGTM, just need to observe that it works ok when the next lotus release happens
Thinking about my request more, I don't think it's really necessary as long as we are diligent about merging the PRs that get opened on cron. I mostly wanted to make sure we had a test in case that cron breaks, but I think those failures will show up in the Github action logs so we're probably good. |
Overview
Added a script that automatically updates lotus versions across filecoin-docs documentation. This helps keep our docs up-to-date without manual updates.
🚨 remove
synchronize
fromupdate-versions.yml
before merging. There for testingWhat changed?
update-versions.js
) that:lotus-x.x.x
formats and standalone version numbers (example:git checkout v1.31.1
)npm run update-version <version-number>
, examplenpm run update-version 1.31.2
How to test?
node update-versions.js <new_version>
lotus-1.31.1
)Here is the test PR created by github action