Jess Bees 4a8f18e34d Add starter workflows for Pages builds and deployments (#1645)
* commit dummy workflow

* Update nextjs.yml

* renaming

* actually do a node build

* add jekyll build & deploy

* add permissions

* update jekyll to use composite upload action

* update next to use composite upload action

* update icon yml

* change nexjs icon

* Cleanup further the Jekyll template

* add gatsby starter workflow

* fix composite error

* fix updated actions

* Add Hugo

* Apply suggestions from code review

* Inital commit for nuxtjs starter workflow

* Cleanup all templates

* Add baseUrl through an action

* Use `base_url` output for Hugo configuration

* Create static.yml

* Create static.properties.json

* clarify path

* alternative jekyll icon with only tube

* use alternate jekyll icon

* use original xvg with proper viewBox parameters

* Add paper-spa/configure-pages to starter workflows

Replaces paper-spa/setup-pages where appropriate.

* use setup-ruby action instead of our container

* Add starter workflow for GitHub Pages's legacy Jekyll build

Named `jekyll-gh-pages` so that it connotes the familiar "hands off"
build process of the Jekyll build as performed by github pages workers,
without sounding deprecated by using the words "legacy" or "classic".

* Use the static_site_generator input so we can modify the correct config

* Update gatsby.yml

* Update wording on the 'legacy' jekyll workflow

* Fix filename: this should have a json extension

* Fix filename: this should have a .properties.json extension

* Update nextjs.properties.json

* Update static.properties.json

* Fix typo in name of Gatsby

* Remove pull_request triggers

* Update to latest versions of core Actions

* Remove '--if-present' flag from 'npm run build' commands to prevent silent failure

* Perform static HTML export for Next.js

* Add '--no-install' flag to 'npx' usage

* Update Nuxt starter workflow to run 'generate'

* Default to using npm if not using yarn

* Reword 'nuxt generate' step name

* Update pages/gatsby.yml

* Update description of Jekyll starter workflow

* Add configure-pages step to static workflow

* Add configuration step to enable Pages

* Pages: Set `PREFIX_PATHS` env var for Gatsby build

* Update Next.js starter workflow to cache builds

See https://nextjs.org/docs/advanced-features/ci-build-caching#github-actions

* Update NuxtJS starter workflow to cache builds

Basically modeled after the Gatsby starter workflow

* Call out node ssg getting started + setup

* Update nuxt documentation

* Retarget actions referencing `paper-spa` to `actions`

Also point to newly published `v1` tags rather than `main` or `v0`.

Co-authored-by: yimysty <yimysty@github.com>
Co-authored-by: Tommy Byrd <tcbyrd@github.com>
Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>
Co-authored-by: Timothy <tjyung@github.com>
Co-authored-by: Smitha Borkar <12040799+smithaborkar@users.noreply.github.com>
Co-authored-by: James M. Greene <JamesMGreene@github.com>
2022-07-27 18:45:54 +05:30
2022-05-20 16:55:27 -07:00
2022-07-27 16:15:08 +05:30
2020-03-21 14:53:31 +00:00
2020-05-20 10:00:39 -07:00
2020-11-24 13:39:40 -08:00
2021-09-24 18:05:34 -04:00

Starter Workflows

These are the workflow files for helping people get started with GitHub Actions. They're presented whenever you start to create a new GitHub Actions workflow.

If you want to get started with GitHub Actions, you can use these starter workflows by clicking the "Actions" tab in the repository where you want to create a workflow.

Directory structure

Each workflow must be written in YAML and have a .yml extension. They also need a corresponding .properties.json file that contains extra metadata about the workflow (this is displayed in the GitHub.com UI).

For example: ci/django.yml and ci/properties/django.properties.json.

Valid properties

  • name: the name shown in onboarding. This property is unique within the repository.
  • description: the description shown in onboarding
  • iconName: the icon name in the relevant folder, for example, django should have an icon icons/django.svg. Only SVG is supported at this time. Another option is to use octicon. The format to use an octicon is octicon <<icon name>>. Example: octicon person
  • creator: creator of the template shown in onboarding. All the workflow templates from an author will have the same creator field.
  • categories: the categories that it will be shown under. Choose at least one category from the list here. Further, choose the categories from the list of languages available here. When a user views the available templates, those templates that match the same language will feature more prominently.

Categories

  • continuous-integration
  • deployment
  • testing
  • code-quality
  • code-review
  • dependency-management
  • monitoring
  • Automation
  • utilities

Variables

These variables can be placed in the starter workflow and will be substituted as detailed below:

  • $default-branch: will substitute the branch from the repository, for example main and master
  • $protected-branches: will substitute any protected branches from the repository
  • $cron-daily: will substitute a valid but random time within the day
Languages
TypeScript 100%