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

docs: individual package support #1479

Merged
merged 10 commits into from
Aug 11, 2016
Merged

docs: individual package support #1479

merged 10 commits into from
Aug 11, 2016

Conversation

callmehiphop
Copy link
Contributor

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 11, 2016
@callmehiphop
Copy link
Contributor Author

@stephenplusplus I'm kinda puzzled on the deployment strategy for this.. seems like there's a lot of duplicated logic between

  • scripts/release.sh
  • scripts/build.sh
  • scripts/publish.js

Should travis be where we update the individual modules JSON in ghpages? Or in the publish script? I'm a little lost about which scripts fire when now.

var parser = require('./parser');
var config = require('./config');

// since we version the JSON in ghpages and we don't create tags for

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

@coveralls
Copy link

coveralls commented Aug 11, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling 78fef07 on callmehiphop:modular-json-docs into 2613bcc on GoogleCloudPlatform:master.

@stephenplusplus
Copy link
Contributor

stephenplusplus commented Aug 11, 2016

I think anything touching gh-pages should be handled by Travis.

publish.js should just be a convenience wrapper around several commands that we would have to run manually, which will

  • create a git tag
  • run npm version
  • run npm publish
  • push to github

Because the publish script in my PR will create a custom git tag (e.g. bigquery-0.1.0), the release.sh script will run because it's a tagged commit. It will need to be modified to parse the git tag (tag.split('-')[0] = module name, tag.split('-')[1] = version number).

@stephenplusplus
Copy link
Contributor

stephenplusplus commented Aug 11, 2016

fixed typo above (npm publish not npm docs)

@@ -24,12 +24,20 @@ npm run system-test
git config --global user.name "travis-ci"
git config --global user.email "travis@travis-ci.org"

if [[ ${TRAVIS_TAG} == *"-"* ]]; then

This comment was marked as spam.

@stephenplusplus
Copy link
Contributor

LGTM!

@coveralls
Copy link

coveralls commented Aug 11, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling bf408fa on callmehiphop:modular-json-docs into 2613bcc on GoogleCloudPlatform:master.

@stephenplusplus stephenplusplus merged commit 885affd into googleapis:master Aug 11, 2016
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 1cb8447 on callmehiphop:modular-json-docs into 2613bcc on GoogleCloudPlatform:master.

stephenplusplus pushed a commit to stephenplusplus/gcloud-node that referenced this pull request Aug 23, 2016
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Oct 11, 2022
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Oct 12, 2022
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Oct 13, 2022
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Nov 10, 2022
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Nov 17, 2022
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Jan 17, 2023
docs: refactor doc scripts for modularization
sofisl pushed a commit that referenced this pull request Sep 14, 2023
docs: refactor doc scripts for modularization
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants