From 38bb60ab2c943ec769b8be6673d943561fd5dc5e Mon Sep 17 00:00:00 2001 From: apbassett <43486400+apbassett@users.noreply.github.com> Date: Fri, 27 Sep 2024 17:05:30 -0400 Subject: [PATCH] Update README, clean up workflow files --- .github/workflows/build-docs.yml | 30 ------------------- .github/workflows/build-pr.yml | 10 +------ .github/workflows/build-release.yml | 26 ----------------- .github/workflows/build.yml | 45 ----------------------------- README.md | 11 +++++++ 5 files changed, 12 insertions(+), 110 deletions(-) delete mode 100644 .github/workflows/build-docs.yml delete mode 100644 .github/workflows/build-release.yml delete mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml deleted file mode 100644 index 81d3060..0000000 --- a/.github/workflows/build-docs.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Build and Deploy Sphinx Docs - -on: - push: - branches: - - main - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Checkout Repo - uses: actions/checkout@v2 - with: - submodules: 'recursive' # Checkout submodules - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: "3.11" - - - name: Install Dependencies - run: pip install -r requirements-3.11.txt - - - name: Build Docs - run: | - make html - - - name: Create CNAME - run: echo 'docs.howso.com' > ./build/html/CNAME diff --git a/.github/workflows/build-pr.yml b/.github/workflows/build-pr.yml index 442511a..03f552f 100644 --- a/.github/workflows/build-pr.yml +++ b/.github/workflows/build-pr.yml @@ -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: @@ -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: diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml deleted file mode 100644 index ddeb47f..0000000 --- a/.github/workflows/build-release.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Build Release -run-name: "Release Build" - -on: - workflow_dispatch: - inputs: - optional-release-tag: - description: "Optional release tag (if empty, will search previous commit titles for MAJOR/MINOR and autoincrement latest tag accordingly)" - required: false - -defaults: - run: - shell: bash - -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - -jobs: - - release: - uses: "./.github/workflows/build.yml" - secrets: inherit - with: - build-type: "release" - optional-release-tag: ${{ inputs.optional-release-tag }} \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 570c733..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: Build -run-name: "Branch Build (${{ github.run_attempt }}.${{ github.run_number }}) - ${{ github.ref_name }}" - -on: - workflow_dispatch: - workflow_call: - inputs: - build-type: - required: false - type: string - optional-release-tag: - required: false - type: string - -defaults: - run: - shell: bash - -jobs: - - metadata: - uses: howsoai/.github/.github/workflows/set-metadata.yml@main - secrets: inherit - with: - build-type: ${{ inputs.build-type }} - optional-release-tag: ${{ inputs.optional-release-tag }} - - release: - needs: - - metadata - if: inputs.build-type == 'release' - permissions: - contents: write - runs-on: ubuntu-latest - steps: - - - name: Create Release - uses: ncipollo/release-action@v1 - with: - tag: ${{ needs.metadata.outputs.version }} - commit: ${{ github.sha }} - name: "${{ github.event.repository.name }} ${{ needs.metadata.outputs.version }}" - artifactErrorsFailBuild: true - generateReleaseNotes: true - makeLatest: legacy \ No newline at end of file diff --git a/README.md b/README.md index 4bb1807..aa674c0 100644 --- a/README.md +++ b/README.md @@ -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)