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

docs: suggest 'auto-publish.yml' as workflow filename #70

Merged
merged 6 commits into from
Jun 1, 2021
Merged

docs: suggest 'auto-publish.yml' as workflow filename #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0d48a2c
docs(examples.md): use 'push-pr.yml' everywhere
marcoscaceres May 28, 2021
beed30c
use auto-publish.yml
marcoscaceres May 28, 2021
abb9288
use auto-publish.yml
marcoscaceres May 28, 2021
a039854
Update docs/examples.md
marcoscaceres May 28, 2021
9c22183
Update docs/examples.md
marcoscaceres May 28, 2021
285ff6f
Merge branch 'main' into examples
marcoscaceres May 28, 2021
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ During a pull request, the action:
Additionally, if a commit is pushed to the "main" branch, the action deploys the built specification to /TR/.

```yml
# .github/workflows/pr-push.yml
# .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand Down
17 changes: 9 additions & 8 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
If you do not pass any inputs, it by default builds a ReSpec or Bikeshed document (`index.html` or `index.bs`) and validates the output. It does not deploy the built document anywhere.

```yaml
# .github/workflows/pr.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand All @@ -23,7 +23,7 @@ jobs:
By default, both hyperlink and markup validators are enabled.

```yaml
# .github/workflows/pr.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand All @@ -44,7 +44,7 @@ jobs:
Specify `TOOLCHAIN` if the action cannot figure out the toolchain itself, or if you like to be explicit.

```yaml
# .github/workflows/pr.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand All @@ -67,7 +67,7 @@ Deployment is only done on `push` events. In this example:
- the document is built and validated, and then deployed to `gh-pages` branch, when a commit is pushed to the `main` branch.

```yaml
# .github/workflows/pr-push.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand All @@ -89,7 +89,7 @@ jobs:
By default, output location is mapped to the `SOURCE`. You can change that by providing a [`DESTINATION`](options.md#destination).

```yaml
# .github/workflows/push.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
push:
Expand All @@ -112,7 +112,7 @@ jobs:
## Deploy to W3C using Echidna

```yaml
# .github/workflows/pr-push.yml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand Down Expand Up @@ -164,6 +164,7 @@ See [`W3C_BUILD_OVERRIDE`](options.md#w3c_build_override) and [`GH_PAGES_BUILD_O
If you've multiple documents in the same repository, you can provide source-destination pairs to build, validate and deploy each one separately.

```yaml
# Create a file called .github/workflows/auto-publish.yml
name: CI
on:
pull_request: {}
Expand Down Expand Up @@ -198,7 +199,7 @@ jobs:
As a <em title="a cumbersome one!">workaround</em>, you can create separate workflows for each document and use GitHub Actions' [`on.<push|pull_request>.paths`](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) as:

```yaml
# .github/workflows/pr-push-spec-1.yml
# Create a file called .github/workflows/auto-publish-spec-1.yml
name: CI (spec-1)
on:
pull_request:
Expand All @@ -221,7 +222,7 @@ jobs:
W3C_ECHIDNA_TOKEN: ${{ secrets.ECHIDNA_TOKEN }}
W3C_WG_DECISION_URL: "https://lists.w3.org/Archives/Public/xyz.html"

# .github/workflows/pr-push-spec-2.yml
# Create another file called .github/workflows/auto-publish-spec-2.yml
name: CI (spec-2)
on:
pull_request:
Expand Down