Skip to content

Commit

Permalink
Update README, clean up workflow files
Browse files Browse the repository at this point in the history
  • Loading branch information
apbassett committed Sep 27, 2024
1 parent 2d58b5d commit 38bb60a
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 110 deletions.
30 changes: 0 additions & 30 deletions .github/workflows/build-docs.yml

This file was deleted.

10 changes: 1 addition & 9 deletions .github/workflows/build-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,7 @@ jobs:
upstream-packages: 'amalgam-lang-py howso-engine-py'
extras: ''

build:
needs: ['gen-requirements']
uses: "./.github/workflows/build.yml"
secrets: inherit
with:
build-type: "PR"

xray:
needs: ['build']
uses: "howsoai/.github/.github/workflows/scan-pull-request.yml@main"
secrets: inherit
with:
Expand All @@ -40,7 +32,7 @@ jobs:
# This job is here to have only one final step to add for "Status Checks"
# in GitHub, instead of adding every leaf test from 'build-test-package'
final-check:
needs: ['build', 'gen-requirements', 'xray']
needs: ['gen-requirements', 'xray']
if: always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled'))
runs-on: ubuntu-latest
steps:
Expand Down
26 changes: 0 additions & 26 deletions .github/workflows/build-release.yml

This file was deleted.

45 changes: 0 additions & 45 deletions .github/workflows/build.yml

This file was deleted.

11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,17 @@ To view the built docs in a web browser, you can run a python http server over t
python -m http.server 8080 --directory ./build/html
```

## Publishing the Docs

For most individuals, in most cases, no action is needed to publish the docs.
Once a PR is merged to `main`, the docs built from that commit will be viewable on Read the Docs under version [latest](https://docs.howso.com/en/latest/).

**Note**: the default behavior of our Read the Docs webpage is to display the docs built from the commit with the `release-latest` tag applied.
This will appear on Read the Docs as `release-latest` and not `latest`.
The `release-latest` tag is applied manually to the intended Git commit in conjunction with our curated release schedule.
The Read the Docs build of the same name will need to be run from the Read the Docs admin page each time the `release-latest` tag is applied to a different commit,
else the content on the webpage under version `release-latest` will not reflect the new commit.

## License

[License](LICENSE.txt)
Expand Down

0 comments on commit 38bb60a

Please sign in to comment.