feat(scripts): push generated docs to material assets repo #2720

riavalon · 2017-01-19T16:57:55Z

Setup scripts for pushing generated docs to material2-docs-content repo on release

devversion · 2017-01-19T18:04:12Z

.travis.yml

@@ -33,6 +33,7 @@ env:
    - MODE=aot
    - MODE=payload
    - MODE=e2e
+    - MODE=docs


The whole mode shouldn't be necessary when we run it with the travis-after-modes script.

devversion · 2017-01-19T18:05:46Z

scripts/release/publish-docs-artifacts.sh

+# If the docs directory is not present, abort
+if [ ! -d $docsPath ]; then
+  echo "Material docs not generated. Aborting..."
+  exit 0


Why not returning an exit code 1 here? If Travis turns red we can see that there are issues with the docs.

devversion · 2017-01-19T18:08:22Z

scripts/release/publish-docs-artifacts.sh

+# git remote show origin
+git config user.name "$commitAuthorName"
+git config user.email "$commitAuthorEmail"
+git config credential.helper "store --file=.git/credentials"


Since the Github credentials are now retrieved from the .git/credentials file, the credentials file needs to be created.

echo "https://${MATERIAL2_BUILDS_TOKEN}:@github.com" > .git/credentials

devversion · 2017-01-19T18:11:59Z

scripts/release/publish-docs-artifacts.sh

+echo "returning to root and removing temp repo"
+cd $root
+rm -rf $tempRepoPath
+echo "Done!"


I don't think that returning to the project directory is necessary here.

Those scripts run most of the time in a child process and don't affect the users PWD.

devversion · 2017-01-19T18:13:29Z

scripts/release/publish-docs-artifacts.sh

+git clone $repoUrl $tempRepoPath
+
+# Clean out repo directory and copy contents of dist/docs into it
+$(find $tempRepoPath -d 1 | grep -v "git" | xargs rm -rf)


How about just calling rm -rf $tempRepoPath /*?

The .git folder won't be affected because the wildcard doesn't cover .* files / folders.

devversion

Code-wise LGTM.

Still thinking about a better name than tmpRepoPath.

jelbourn · 2017-01-19T21:47:22Z

scripts/release/publish-docs-artifacts.sh

+cd "$(dirname $0)/../../"
+
+docsPath="./dist/docs"
+tempRepoPath="./dist/tempRepo"


Rather than writing to dist/, /tmp/material2-docs-content would be more appropriate (since it's not the output of a build).

I think that just repoDir or repoPath is good.

jelbourn · 2017-01-19T21:50:24Z

scripts/release/publish-docs-artifacts.sh

+
+# Clean out repo directory and copy contents of dist/docs into it
+rm -rf $tempRepoPath/*
+mkdir $tempRepoPath/docs


I don't think that the content needs to all go into a docs directory. The structure should look something like

material2-docs-content ├─ overview ├─ guides ├─ api └─ examples

Realized I should add a bit more here; we should:

Change the current gulp docs task to be called gulp markdown-docs

Change the current gulp api to gulp api-docs

Add a new task called gulp docs that just runs the previous two

Change gulp api-docs to output to dist/docs/api and markdown-docs to output to dist/docs/markdown

This should make it easier for this script to massage the different types of docs into the right place (and still only need to run one command).

Also while we are talking about naming. Can we rename the file to publish-docs-content.sh?

Artifacts sounds like we are building a release of the components

jelbourn · 2017-01-19T22:08:16Z

scripts/release/publish-docs-artifacts.sh

+
+docsPath="./dist/docs"
+tempRepoPath="./dist/tempRepo"
+repoUrl="https://github.com/angular/material2-docs-content"


It would be good to let this do a few test runs before committing to the real repo. We did this for the material2-builds; you can do the same by:

Fork angular/material2-docs-content

Add an access token for said fork to our Travis CI environment

Update this script to use that token instead of MATERIAL2_BUILDS_TOKEN

We can then just let it run for a few commits and make sure it looks good before updating the repo / access token.

I don't think everybody can create Travis encrypted variables. I can create a small repo for it and we don't need to change the token at all. (Since its currently running over my token)

@devversion That's probably easier

Okay so here is the repository: https://github.com/DevVersion/material2-docs-content.git

@jelbourn In the future we can probably switch to another token.

jelbourn

Just a couple last comments!

jelbourn · 2017-01-24T22:46:21Z

scripts/release/publish-docs-content.sh

+cd "$(dirname $0)/../../"
+
+docsPath="./dist/docs"
+repoPath="./tmp/material2-docs-content"


Can you change to to /tmp instead of ./tmp?
(here and elsewhere)

jelbourn · 2017-01-24T22:48:06Z

scripts/release/publish-docs-content.sh

+overviewFiles=$docsPath/markdown/
+
+# Move api files over to $repoPath/api
+cp -r $docsPath/api/ $repoPath/api


It looks like this is creating a structure of material2-docs-assets/api/api (api is in there twice)

jelbourn

LGTM

kara · 2017-02-03T22:47:43Z

@riavalon Can you rebase?

angular-automatic-lock-bot · 2019-09-06T08:01:14Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Jan 19, 2017

devversion reviewed Jan 19, 2017

View reviewed changes

riavalon force-pushed the feat-add-docs-publishing-script branch 3 times, most recently from f101822 to 9d8847e Compare January 19, 2017 19:03

devversion approved these changes Jan 19, 2017

View reviewed changes

devversion assigned jelbourn Jan 19, 2017

devversion added the pr: needs review label Jan 19, 2017

jelbourn reviewed Jan 19, 2017

View reviewed changes

riavalon force-pushed the feat-add-docs-publishing-script branch from 9d8847e to 23f4f38 Compare January 23, 2017 20:19

jelbourn reviewed Jan 24, 2017

View reviewed changes

riavalon force-pushed the feat-add-docs-publishing-script branch from 51bbb77 to ab8dd2d Compare January 25, 2017 15:34

jelbourn approved these changes Jan 30, 2017

View reviewed changes

jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Jan 30, 2017

kara added pr: needs rebase and removed action: merge The PR is ready for merge by the caretaker labels Feb 3, 2017

feat(scripts): push generated docs to material assets repo

ed277d0

riavalon force-pushed the feat-add-docs-publishing-script branch from ab8dd2d to ed277d0 Compare February 4, 2017 21:09

kara added action: merge The PR is ready for merge by the caretaker and removed pr: needs rebase labels Feb 6, 2017

tinayuangao merged commit ba12f44 into angular:master Feb 6, 2017

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(scripts): push generated docs to material assets repo #2720

feat(scripts): push generated docs to material assets repo #2720

riavalon commented Jan 19, 2017

devversion Jan 19, 2017

devversion Jan 19, 2017

devversion Jan 19, 2017

devversion Jan 19, 2017

devversion Jan 19, 2017

devversion left a comment

jelbourn Jan 19, 2017

jelbourn Jan 19, 2017 •

edited

Loading

jelbourn Jan 19, 2017

devversion Jan 20, 2017

jelbourn Jan 19, 2017

devversion Jan 19, 2017

jelbourn Jan 19, 2017

devversion Jan 20, 2017

jelbourn left a comment

jelbourn Jan 24, 2017

jelbourn Jan 24, 2017

jelbourn left a comment

kara commented Feb 3, 2017

angular-automatic-lock-bot bot commented Sep 6, 2019

feat(scripts): push generated docs to material assets repo #2720

feat(scripts): push generated docs to material assets repo #2720

Conversation

riavalon commented Jan 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devversion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jelbourn Jan 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jelbourn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jelbourn left a comment

Choose a reason for hiding this comment

kara commented Feb 3, 2017

angular-automatic-lock-bot bot commented Sep 6, 2019

jelbourn Jan 19, 2017 •

edited

Loading