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.

Sign up for GitHub

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

Jump to bottom

fix: add Publishing workflow to README #22

Merged
merged 3 commits into from
Sep 15, 2020
Merged

fix: add Publishing workflow to README #22

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f95b1f
fix: add Publishing workflow to README
shazron Sep 15, 2020
957e2da
fix: elaborate PR approval flow, master vs main (Oct 1st change-over)…
shazron Sep 15, 2020
1168e42
fix: rename Github to GitHub
shazron Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 32 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ This section will help you get started building a Gatsby site with Gatsby Theme
* Install [Node.js LTS](https://nodejs.org/en/download/)
* Install a package manager like [npm](https://docs.npmjs.com/cli/npm) or [yarn]()

### Using Github repository templates
### Using GitHub repository templates

To initialize a site repository, you can also use of the available templates in Github:
To initialize a site repository, you can also use of the available templates in GitHub:

* [Documentation site template](https://github.com/adobe/gatsby-theme-parliament-documentation/)
* [Platform site template](https://github.com/adobe/gatsby-theme-parliament-platform/) WIP
Expand Down Expand Up @@ -144,13 +144,13 @@ Follow these steps to configure your `.env` file.

**The .env should not be committed.**

Github's API is being called during the site build phase to retrieve the authors of every markdown page under `src/pages`.
If the Github Token information is missing, the build will just print a warning, and no contributor information will be retrieved (just the contributor information in a page's front matter, if any, will be used).
GitHub's API is being called during the site build phase to retrieve the authors of every markdown page under `src/pages`.
If the GitHub Token information is missing, the build will just print a warning, and no contributor information will be retrieved (just the contributor information in a page's front matter, if any, will be used).

To retrieve your Github personal access token, you can follow these [steps](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
To retrieve your GitHub personal access token, you can follow these [steps](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
Only `READ` permissions on repositories are required for the token.

### .env settings for Github Contributors
### .env settings for GitHub Contributors

For example, if your doc site repo was at https://github.com/adobe/gatsby-theme-parliament using the `main` branch, this would be what your `.env` would look like:

Expand Down Expand Up @@ -192,6 +192,29 @@ Example:
GATSBY_LAUNCH_SRC=https://your.adobe.launch.url.here
GATSBY_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT=true
```
### Publishing to GitHub Pages (Dev)

On every commit to the `master` branch, the site will be built to GitHub Pages automatically, for you to preview as a development version. This is the default for new repos in GitHub: on Oct 1st, this will [default to main](https://github.blog/changelog/2020-08-26-set-the-default-branch-for-newly-created-repositories/)

`GitHub Contributors component`: this will use the GitHub token automatically provided by the GitHub Action to retrieve data

`Feedback component`: no environmental variable should be set since GitHub Pages should only be for development purposes

### Publishing to Azure Storage Static Websites (Production)

A site is published via a Pull Request:
1. The Pull Request must be `approved`
2. The Pull Request should be tagged with the `deploy` label (Production deploy) AND/OR
3. The Pull Request should be tagged with the `deploy:dev` label (Dev deploy)

**Pre-requisites:**
1. Create a GitHub label called `deploy` if it does not exist
2. Create a GitHub label called `deploy:dev` if it does not exist
3. Add a Azure Blob Storage connection string GitHub Secret for `production` called `AZURE_PROD_CONNECTION_STRING`
4. Add a Azure Blob Storage connection string GitHub Secret for `development` called `AZURE_DEV_CONNECTION_STRING`
4. Add a Adobe Launch URL GitHub Secret called `GATSBY_LAUNCH_URL` (see section above for the Feedback component)
Copy link
Contributor

Choose a reason for hiding this comment

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

@shazron want to set these 3 secrets at the org level so folks don't have to add them manually?

6. The Pull Request must be on a `branch in the same repo` (this is a GitHub Actions security restriction for secrets access)
7. The person initiating the Pull Request must have a `Contributor` role to the repo (because of the previous requirement)

### Global Navigation

Expand Down Expand Up @@ -444,8 +467,8 @@ description: This is the guides overview page of Adobe Analytics

### Specifying external contributors

In addition to the Github contributors of a markdown file, you can specify external contributors with front matter.
They'll show up first before the Github contributors.
In addition to the GitHub contributors of a markdown file, you can specify external contributors with front matter.
They'll show up first before the GitHub contributors.

<pre>
---
Expand Down Expand Up @@ -520,7 +543,7 @@ Use Resources List to display a side list of links. Those links can point to int
#### Resources

* [Quickstart Guide](https://www.adobe.io/apis/experiencecloud/analytics/docs.html)
* [Adobe Analytics Github Repo](https://github.com/AdobeDocs/analytics-2.0-apis)
* [Adobe Analytics GitHub Repo](https://github.com/AdobeDocs/analytics-2.0-apis)
```

*Use `slots` to identify the markdown content to be used by the Resources List.*
Expand Down