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 release instructions for modifying notebook paths #3027

Merged
merged 1 commit into from
Mar 10, 2023

Conversation

gidler
Copy link
Collaborator

@gidler gidler commented Mar 10, 2023

Description of changes:

During release, the repository notebook paths for Colab and Studio lab links need to be updated in the AutoGluon tutorials. This one line change adds instructions to do this.

Testing:
I tested the command on macOS because I believe that is the OS most developers will be using during release preparation.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@@ -51,6 +51,7 @@
* Cut a release branch with format `0.x.y` (no v) - this branch is required to publish docs to versioned path
* Clone from master branch
* Add 1 commit to the release branch to remove pre-release warnings and update install instructions to remove `--pre`: [Old diff](https://github.com/autogluon/autogluon/commit/1d66194d4685b06e884bbf15dcb97580cbfb9261)
* Add 1 commit that converts notebook links from `master` to `stable` by running this command from the root project directory: `LC_ALL=C find docs/tutorials/ -type f -exec sed -i '' 's#blob/master/docs#blob/stable/docs#' {} +`
Copy link
Collaborator Author

@gidler gidler Mar 10, 2023

Choose a reason for hiding this comment

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

LC_ALL=C is used because of this and explained here.

@github-actions
Copy link

Job PR-3027-d7665c9 is done.
Docs are uploaded to http://autogluon-staging.s3-website-us-west-2.amazonaws.com/PR-3027/d7665c9/index.html

@gidler gidler requested a review from gradientsky March 10, 2023 19:03
@gidler gidler merged commit 8a391cd into autogluon:master Mar 10, 2023
gradientsky pushed a commit to gradientsky/autogluon that referenced this pull request Mar 10, 2023
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.

None yet

2 participants