-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make Ruby rundoc tutorial (more) dynamic and add .NET (#63)
* Update Rundoc version * Simplify ruby RUNDOC.md * Re-write Ruby docs to be dynamic * Rename main markdown file * Use 5006 for port Same port as `heroku local` * Update rundoc filename * Update README now that Fir is announced * Add a explanation to the docs folder Includes information on how to build the docs. * Add links to tutorials from README * Re-order arguments It's prettier * Update to make slightly more dynamic We still can't extract the article into it's own section, but this makes some progress. * Remove "ruby" from shared docs * Update rundoc version * Add dotnet * Ignore ruby getting started guide instead of deleting * Update CI to add dotnet
- Loading branch information
Showing
55 changed files
with
4,296 additions
and
524 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,12 @@ on: | |
jobs: | ||
test-rundoc: | ||
runs-on: ubuntu-latest | ||
env: | ||
BUNDLE_GEMFILE: .rundoc-workspace/Gemfile | ||
strategy: | ||
matrix: | ||
lang: ["ruby", "dotnet", "nodejs", "python", "php", "go", "java_maven", "java_gradle", "scala"] | ||
fail-fast: false | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
|
@@ -15,9 +21,11 @@ jobs: | |
with: | ||
ruby-version: "3.3" | ||
bundler-cache: true # do run 'bundle install' and cache | ||
working-directory: .rundoc-workspace | ||
- uses: buildpacks/github-actions/[email protected] | ||
|
||
# [CONFIG] add different languages set up here | ||
- run: bundle exec rundoc ../docs/src/ruby/ruby_tutorial.md --on-success-dir ../docs/ruby --on-failure-dir ../docs/fail --force | ||
working-directory: .rundoc-workspace | ||
- run: | | ||
bundle exec rundoc docs/src/${{ matrix.lang }}/RUNDOC.md \ | ||
--on-success-dir docs/${{ matrix.lang }} \ | ||
--on-failure-dir docs/fail/${{ matrix.lang }} \ | ||
--force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,12 @@ on: | |
jobs: | ||
run-rundoc: | ||
runs-on: pub-hk-ubuntu-24.04-ip | ||
env: | ||
BUNDLE_GEMFILE: .rundoc-workspace/Gemfile | ||
strategy: | ||
matrix: | ||
lang: ["ruby", "dotnet", "nodejs", "python", "php", "go", "java_maven", "java_gradle", "scala"] | ||
fail-fast: false | ||
steps: | ||
- name: Get token for GH application (Linguist) | ||
uses: actions/create-github-app-token@v1 | ||
|
@@ -25,23 +31,21 @@ jobs: | |
with: | ||
ruby-version: "3.3" | ||
bundler-cache: true # do run 'bundle install' and cache | ||
working-directory: .rundoc-workspace | ||
- uses: buildpacks/github-actions/[email protected] | ||
|
||
# [CONFIG] add different languages set up here | ||
- run: bundle exec rundoc ../docs/src/ruby/ruby_tutorial.md --on-success-dir ../docs/ruby --on-failure-dir ../docs/fail --force | ||
working-directory: .rundoc-workspace | ||
- run: | | ||
bundle exec rundoc docs/src/${{ matrix.lang }}/RUNDOC.md \ | ||
--on-success-dir docs/${{ matrix.lang }} \ | ||
--on-failure-dir docs/fail/${{ matrix.lang }} \ | ||
--force | ||
continue-on-error: true | ||
- run: rm -rf ruby-getting-started | ||
working-directory: docs/ruby | ||
continue-on-error: true | ||
|
||
- name: Create Pull Request | ||
id: pr | ||
uses: peter-evans/create-pull-request@v7 | ||
with: | ||
token: ${{ steps.generate-token.outputs.token }} | ||
branch: rundoc-update | ||
branch: rundoc-update-${{ matrix.lang }} | ||
delete-branch: true | ||
base: main | ||
commit-message: Update tutorials | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.