| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| name: Update doc DB | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| python-version: | ||
| description: Target python version to generate doc db for | ||
| type: string | ||
| default: "3.13.9" | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
| working-directory: ./crates/rustpython-doc | ||
|
|
||
| jobs: | ||
| generate: | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| matrix: | ||
| os: | ||
| - ubuntu-latest | ||
| - windows-latest | ||
| - macos-latest | ||
| steps: | ||
| - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | ||
| with: | ||
| persist-credentials: false | ||
| sparse-checkout: | | ||
| crates/rustpython-doc | ||
|
|
||
| - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 | ||
| with: | ||
| python-version: ${{ inputs.python-version }} | ||
|
|
||
| - name: Generate docs | ||
| run: python ./generate.py | ||
|
|
||
| - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | ||
| with: | ||
| name: doc-db-${{ inputs.python-version }}-${{ matrix.os }} | ||
| path: "crates/rustpython-doc/generated/*.json" | ||
| if-no-files-found: error | ||
| retention-days: 7 | ||
| overwrite: true | ||
|
|
||
| merge: | ||
| runs-on: ubuntu-latest | ||
| needs: generate | ||
| steps: | ||
| - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | ||
| with: | ||
| persist-credentials: false | ||
| sparse-checkout: | | ||
| crates/rustpython-doc | ||
|
|
||
| - name: Download generated doc DBs | ||
| uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0 | ||
| with: | ||
| pattern: "doc-db-${{ inputs.python-version }}-**" | ||
| path: crates/rustpython-doc/generated/ | ||
| merge-multiple: true | ||
|
|
||
| - name: Transform JSON | ||
| run: | | ||
| # Merge all artifacts | ||
| jq -s "add" --sort-keys generated/*.json > generated/merged.json | ||
|
|
||
| # Format merged json for the phf macro | ||
| jq -r 'to_entries[] | " \(.key | @json) => \(.value | @json),"' generated/merged.json > generated/raw_entries.txt | ||
|
|
||
| OUTPUT_FILE='src/data.inc.rs' | ||
|
|
||
| echo -n '' > $OUTPUT_FILE | ||
|
|
||
| echo '// This file was auto-generated by `.github/workflows/update-doc-db.yml`.' >> $OUTPUT_FILE | ||
| echo "// CPython version: ${{ inputs.python-version }}" >> $OUTPUT_FILE | ||
| echo '// spell-checker: disable' >> $OUTPUT_FILE | ||
|
|
||
| echo '' >> $OUTPUT_FILE | ||
|
|
||
| echo "pub static DB: phf::Map<&'static str, &'static str> = phf::phf_map! {" >> $OUTPUT_FILE | ||
| cat generated/raw_entries.txt >> $OUTPUT_FILE | ||
| echo '};' >> $OUTPUT_FILE | ||
|
|
||
| - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 | ||
| with: | ||
| name: doc-db-${{ inputs.python-version }} | ||
| path: "crates/rustpython-doc/src/data.inc.rs" | ||
| if-no-files-found: error | ||
| retention-days: 7 | ||
| overwrite: true | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| generated/ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [package] | ||
| name = "rustpython-doc" | ||
| version.workspace = true | ||
| authors.workspace = true | ||
| edition.workspace = true | ||
| rust-version.workspace = true | ||
| repository.workspace = true | ||
| license-file = "LICENSE" | ||
|
|
||
| [dependencies] | ||
| phf = { workspace = true } | ||
|
|
||
| [lib] | ||
| doctest = false # Crashes when true | ||
|
|
||
| [lints] | ||
| workspace = true |
| Back | FazBrowse Home | New Git URL |
Uh oh!
There was an error while loading. Please reload this page.