Skip to content

Commit

Permalink
ci: fix deploy docs workflow trigger (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
julesbertrand authored Feb 27, 2024
1 parent eff01cb commit 32351db
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/deploy_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
name: Deploy doc to GitHub Pages

on:
push:
branches:
- 'main'
release:
types:
- published
workflow_dispatch:

env:
python-version: "3.10"
Expand Down
1 change: 1 addition & 0 deletions docs/CLI_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ $ vertex-deployer check [OPTIONS] PIPELINE_NAMES...
* `PIPELINE_NAMES...`: The names of the pipeline to create. [optional]

**Options**:

* `--all, -a / --no-all`: Whether to check all pipelines. [default: no-all]
* `--config-filepath, -cfp PATH`: Path to the json/py file with parameter values and input artifacts to check. If not specified, all config files in the pipeline dir will be checked.
* `--warn-defaults, -wd / --no-warn-defaults, -nwd`: Whether to warn when a default value is used and not overwritten in config file. [default: warn-defaults]
Expand Down
9 changes: 9 additions & 0 deletions templates/.release_notes.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## {{ version.as_tag() }} ({{ release.tagged_date.strftime("%Y-%m-%d") }})
{% for type_, commits in release["elements"] | dictsort %}
{% if type_ == "enh" %}
### {{ "Enhancements" | capitalize }}
{% else %}
### {{ type_ | capitalize }}
{% endif %}{%- if type_ != "unknown" %}{% for commit in commits %}
* {{ commit.descriptions[0] }} by {{commit.commit.author.name}} in [`{{ commit.short_hash }}`]({{ commit.hexsha | commit_hash_url }})
{%- endfor %}{% endif %}{% endfor %}

0 comments on commit 32351db

Please sign in to comment.