Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Script for publishing rustdocs at gh-pages #10604

Merged
merged 7 commits into from
Jan 21, 2022
Merged

Script for publishing rustdocs at gh-pages #10604

merged 7 commits into from
Jan 21, 2022

Conversation

@jimmychu0807
Copy link
Contributor

@jimmychu0807 jimmychu0807 commented Jan 7, 2022 •
edited
Loading

This is a followup PR of #9856.

Per @TriplEight comment, now it is using a shell script to handle rustdocs release.

Usages:

# Examples:
rustdocs-release.sh -h                        # Shows help text
rustdocs-release.sh deploy monthly-2021-10    # Builds and deploys `monthly-2021-10` branch/tag rustdocs
rustdocs-release.sh deploy -l monthly-2021-10 # Builds and deploys `monthly-2021-10` branch/tag rustdocs, and `latest` symlink is pointing to the doc dir
rustdocs-release.sh remove monthly-2021-10    # Remove the rustdocs of `monthly-2021-10`

@sacha-l @nukemandan

rustdocs of monthly-2021-12 and monthly-2022-01 tags have been deployed using this script at:

@jimmychu0807 jimmychu0807 requested a review from a team as a code owner January 7, 2022 07:39
@github-actions github-actions bot added the A0-please_review Pull request needs code review. label Jan 7, 2022
@jimmychu0807 jimmychu0807 added B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Jan 7, 2022
@jimmychu0807 jimmychu0807 changed the title Script for publishing rustdocs Script for publishing Substrate rustdocs at gh-pages Jan 7, 2022
@jimmychu0807 jimmychu0807 changed the title Script for publishing Substrate rustdocs at gh-pages Script for publishing rustdocs at gh-pages Jan 7, 2022
alvicsam
alvicsam approved these changes Jan 18, 2022
View reviewed changes
Copy link
Contributor

@alvicsam alvicsam left a comment

Choose a reason for hiding this comment

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

LGTM, I have only one comment: I think it would be better to publish @jimmychu0807/index-tpl-crud in @parity or @substrate at npmjs.com

@radupopa2010 radupopa2010 self-requested a review January 18, 2022 10:16
@jimmychu0807
Copy link
Contributor Author

jimmychu0807 commented Jan 18, 2022 •
edited
Loading

Let me check the requirement of publishing a package under @substrate.

@jimmychu0807
Copy link
Contributor Author

@alvicsam
I have transferred index-tpl-crud project to Substrate devhub. Will update the node published package to under @substrate namespace in my next PR. Would love to merge this first and have the team using it.

TriplEight
TriplEight approved these changes Jan 21, 2022
View reviewed changes
@TriplEight TriplEight merged commit af5e675 into master Jan 21, 2022
@TriplEight TriplEight deleted the jc/publish-rustdocs-script branch January 21, 2022 17:32
@jimmychu0807 jimmychu0807 mentioned this pull request Jan 24, 2022
Merged
eskimor pushed a commit that referenced this pull request Jan 27, 2022
@eskimor
Script for publishing rustdocs at gh-pages (#10604)
491b5a9 
* wip

Signed-off-by: Jimmy Chu <[email protected]>

* Added the rustdocs-release script

Signed-off-by: Jimmy Chu <[email protected]>

* updated gitlab-ci script

Signed-off-by: Jimmy Chu <[email protected]>

* Updated to set NIGHTLY to false by default

Signed-off-by: Jimmy Chu <[email protected]>

* Added documentation

Signed-off-by: Jimmy Chu <[email protected]>
Wizdave97 pushed a commit to ComposableFi/substrate that referenced this pull request Feb 4, 2022
@Wizdave97
Script for publishing rustdocs at gh-pages (paritytech#10604)
fbc8644 
* wip

Signed-off-by: Jimmy Chu <[email protected]>

* Added the rustdocs-release script

Signed-off-by: Jimmy Chu <[email protected]>

* updated gitlab-ci script

Signed-off-by: Jimmy Chu <[email protected]>

* Updated to set NIGHTLY to false by default

Signed-off-by: Jimmy Chu <[email protected]>

* Added documentation

Signed-off-by: Jimmy Chu <[email protected]>
grishasobol pushed a commit to gear-tech/substrate that referenced this pull request Mar 28, 2022
@grishasobol
Script for publishing rustdocs at gh-pages (paritytech#10604)
80ef98f 
* wip

Signed-off-by: Jimmy Chu <[email protected]>

* Added the rustdocs-release script

Signed-off-by: Jimmy Chu <[email protected]>

* updated gitlab-ci script

Signed-off-by: Jimmy Chu <[email protected]>

* Updated to set NIGHTLY to false by default

Signed-off-by: Jimmy Chu <[email protected]>

* Added documentation

Signed-off-by: Jimmy Chu <[email protected]>
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
@ark0f
Script for publishing rustdocs at gh-pages (paritytech#10604)
018dc20 
* wip

Signed-off-by: Jimmy Chu <[email protected]>

* Added the rustdocs-release script

Signed-off-by: Jimmy Chu <[email protected]>

* updated gitlab-ci script

Signed-off-by: Jimmy Chu <[email protected]>

* Updated to set NIGHTLY to false by default

Signed-off-by: Jimmy Chu <[email protected]>

* Added documentation

Signed-off-by: Jimmy Chu <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

3 more reviewers

@radupopa2010 radupopa2010 radupopa2010 approved these changes

@TriplEight TriplEight TriplEight approved these changes

@alvicsam alvicsam alvicsam approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jimmychu0807 @radupopa2010 @TriplEight @alvicsam