Skip to content

Commit

Permalink
Sync version between release and package (#349)
Browse files Browse the repository at this point in the history
  • Loading branch information
mik-laj authored Dec 11, 2020
1 parent e34e602 commit 73cd075
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,13 @@ jobs:
github.event_name == 'push'
run: |
gh auth status
gh release delete v0.0.3 -y || true
VERSION="$(python setup.py --version)"
TITLE=$(date "+%Y-%m-%d %H:%M:%S")
NOTES="Commit: ${GITHUB_COMMIT}
Source: ${GITHUB_REF}"
gh release create v0.0.3 \
--title "Latest version" \
gh release delete "${VERSION}" -y || true
gh release create "${VERSION}" \
--title "${TITLE}" \
--notes "${NOTES}" \
./dist/*
12 changes: 7 additions & 5 deletions sphinx_airflow_theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,26 @@ In order to start working with the theme, please follow the instructions below.
```

2. To make Javascript and CSS code available for the theme, run the following command in the root directory:
```
```shell script
./site.sh build-site && ./site.sh prepare-theme
```

3. To install the required Python packages, in `<ROOT DIRECTORY>/sphinx_airflow_theme` run:
```
```shell script
pip install -e .
```

4. To launch the demo documentation page, in `<ROOT DIRECTORY>/sphinx_airflow_theme/demo` run:
```
```shell script
./docs.sh build && ./docs.sh preview
```

# Install developer version

To install the latest development version of a theme, run:
```
pip install 'https://github.com/apache/airflow-site/releases/download/v0.0.3/sphinx_airflow_theme-0.0.3-py3-none-any.whl'
```shell script
THEME_VERSION="$(curl -s https://api.github.com/repos/apache/airflow-site/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)"
pip install "https://github.com/apache/airflow-site/releases/download/${THEME_VERSION}/sphinx_airflow_theme-${THEME_VERSION}-py3-none-any.whl"
```
Python packages for your PRs is available as downloadable artifact in GitHub Actions after
the CI builds your PR.
Expand All @@ -69,6 +70,7 @@ html_theme_options = {
'navbar_links': [
{'href': '/docs/', 'text': 'Documentation'}
]
}
```

(This is the default)
Expand Down
2 changes: 1 addition & 1 deletion sphinx_airflow_theme/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

setup(
name='sphinx_airflow_theme',
version='0.0.2',
version='0.0.4',
url='https://github.com/apache/airflow-site/tree/aip-11',
license='Apache License 2.0',
author='Apache Software Foundation',
Expand Down

0 comments on commit 73cd075

Please sign in to comment.