rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-16 14:53:28 +02:00
Code Issues Releases Activity
8e4bf245d3
comprehensive-rust/.github/workflows/publish.yml

62 lines
1.3 KiB
YAML
Raw Normal View History

Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
name: Publish
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
on:
push:
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
branches:
- main
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
group: pages
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
cancel-in-progress: true
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
env:
CARGO_TERM_COLOR: always
Publish Brazilian Portuguese translation (#381) The IETF language tag for “Brazilian Portuguese” is “pt-BR”[1]. This tag is also used in the HTML lang attribute[2]. We derive the language code directly from the “.po” filename, so I’ve renamed “pt_BR.po” to “pt-BR.po” make everything use the correct language code. Nothing in the Gettext pipeline cares about the precise filename, so it should be fine to rename it like this. [1]: https://en.wikipedia.org/wiki/Brazilian_Portuguese#Language_codes [2]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang
2023-02-13 15:45:58 +02:00
LANGUAGES: da pt-BR
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
jobs:
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
publish:
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Simplify the publish workflow This removes a bunch of boiler-plate comments which were left from the template I used originally. It also simplifies the name to just “Publish” since I feel this fits better for what we do here.
2023-01-03 15:54:30 +02:00
- name: Setup Rust cache
Extract common build steps to composite actions (#242) * Extract common build steps to composite actions This allows us to repeat ourselves less across the different jobs. I also tested using a “reusable workflow” to factor out the common steps. However, this starts a separate job without a shared filesystem, which in turn requires us to upload/download artifacts when we want to use them in several jobs. The artifacts are downloaded one-by-one and this adds delays and extra steps to all jobs. * Move Rust cache setup to its own build step This made it easy to consistently setup the caching of our nested projects via the “workspacs” config key.
2023-01-23 18:08:29 +02:00
uses: ./.github/workflows/setup-rust-cache
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
- name: Install mdbook
Extract common build steps to composite actions (#242) * Extract common build steps to composite actions This allows us to repeat ourselves less across the different jobs. I also tested using a “reusable workflow” to factor out the common steps. However, this starts a separate job without a shared filesystem, which in turn requires us to upload/download artifacts when we want to use them in several jobs. The artifacts are downloaded one-by-one and this adds delays and extra steps to all jobs. * Move Rust cache setup to its own build step This made it easy to consistently setup the caching of our nested projects via the “workspacs” config key.
2023-01-23 18:08:29 +02:00
uses: ./.github/workflows/install-mdbook
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Publish translations to `/xx` subdirectories (#264) This publishes translations (currently only the Danish translation) to subdirectories named after the ISO 639-1 language code: “da/” for Danish, “ko/” for Korean, etc. The list of translation is an explicit list to make it easy for us to enable/disable translations without being tied to the files in po/. This allows us to experiment with a translation without publishing it immediately. I propose that we eventually move the English pages to an “en/” directory for symmetry with the other locales. However, for now, the pages remain at the room of our site (which works fine since we don’t have a subdirectory named “en/” in the course).
2023-01-24 13:07:04 +02:00
- name: Build course in English
run: mdbook build -d book
- name: Build all translations
run: |
for po_lang in ${{ env.LANGUAGES }}; do
MDBOOK_BOOK__LANGUAGE=$po_lang \
MDBOOK_PREPROCESSOR__GETTEXT__PO_FILE=po/$po_lang.po \
MDBOOK_OUTPUT__HTML__SITE_URL=/comprehensive-rust/$po_lang/ \
mdbook build -d book/$po_lang
done
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
- name: Setup Pages
uses: actions/configure-pages@v2
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
Publish translations to `/xx` subdirectories (#264) This publishes translations (currently only the Danish translation) to subdirectories named after the ISO 639-1 language code: “da/” for Danish, “ko/” for Korean, etc. The list of translation is an explicit list to make it easy for us to enable/disable translations without being tied to the files in po/. This allows us to experiment with a translation without publishing it immediately. I propose that we eventually move the English pages to an “en/” directory for symmetry with the other locales. However, for now, the pages remain at the room of our site (which works fine since we don’t have a subdirectory named “en/” in the course).
2023-01-24 13:07:04 +02:00
path: book
Cache the artifacts built by the publish workflow This should speed up the publication: right now we spend around 4 minutes to build `mdbook` and `mdbook-svgbob`. With this change, we will only pay that cost once a week (caches created by GitHub Actions last 7 days[1]). [1]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy
2022-12-21 19:43:12 +02:00
Create publish.yml This is for publishing the course on GitHub Pages.
2022-12-21 17:50:05 +02:00
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
Reference in New Issue Copy Permalink