-
Notifications
You must be signed in to change notification settings - Fork 214
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
chore: automate devcenter documentation updates #2774
base: main
Are you sure you want to change the base?
Conversation
e3c5889
to
206c4e5
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.
LGTM
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. couple questions just verifying things. but yeah, great work!
@@ -25,7 +25,7 @@ | |||
"@heroku-cli/schema": "^1.0.25", | |||
"@heroku/buildpack-registry": "^1.0.1", | |||
"@heroku/eventsource": "^1.0.7", | |||
"@oclif/core": "^2.8.11", | |||
"@oclif/core": "^2.16.0", |
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.
Somewhat significant jump in oclif/core
but I don't see much in the changelog that we should be worried about. I noticed 2.16 was released literally yesterday (doesn't even show up in the changelog yet, heh). I think you had described to me something that the oclif team fixed that you asked about. Is that the update with 2.16?
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.
Yes. They released a fix for us that allows for hidden aliases. We need it for the v9 release as well, so this was really helpful.
- name: Compile documentation and push to devcenter | ||
run: | | ||
cd packages/cli | ||
./scripts/postrelease/dev_center_docs |
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.
At the end of this it runs devcenter push /tmp/heroku-cli-commands.md
.. were you able to test that this works by running this on your local machine (and doing gem install devcenter
)?
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.
That is my next step. I just wanted someone else to look over all of this first before running that script.
This PR completes the github action for updating our devcenter CLI commands documentation. Once we are sure this works, I will add it to our deploy workflows.
Notes
oclif readme
command does not add the link to the code for each command in the CLI repo. This should be resolved when we release v9 of the CLI, so we have decided to leave it for now.plugins:install
,plugins:uninstall
, andversion
commands that were not previously included.Testing
Before pushing the new documentation to devcenter