ollama-utils: add publish and cronjob workflows #1206
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| name: Ollama template update | ||
| on: | ||
| # push: # for debugging | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: '0 7 * * 1' # every monday at 7am, so I'll review it after having a 🥐 | ||
|
|
||
| permissions: | ||
| pull-requests: write # for creating PR | ||
| issues: write # for adding labels to the created PR | ||
| contents: write # for git push new branch | ||
|
|
||
| jobs: | ||
| update-ollama-templates: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| if: github.repository == 'huggingface/huggingface.js' | ||
|
|
||
| - name: Prepare | ||
| id: prepare | ||
| if: github.repository == 'huggingface/huggingface.js' | ||
| shell: bash | ||
| run: | | ||
| git config --global user.name machineuser | ||
| git config --global user.email [email protected] | ||
| git config --global --add safe.directory "$GITHUB_WORKSPACE" | ||
| npm install -g pnpm | ||
| CURRENT_DATE=$(date -u +"%Y-%m-%d") | ||
| echo "CURRENT_DATE=$CURRENT_DATE" | ||
| echo "CURRENT_DATE=$CURRENT_DATE" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Install dependencies | ||
| if: github.repository == 'huggingface/huggingface.js' | ||
| shell: bash | ||
| run: | | ||
| cd packages/ollama-utils | ||
| pnpm install --frozen-lockfile | ||
|
|
||
| - name: Run update script | ||
| if: github.repository == 'huggingface/huggingface.js' | ||
| shell: bash | ||
| run: | | ||
| cd packages/ollama-utils | ||
| pnpm run build:automap | ||
|
|
||
| - name: Check for changed files | ||
| id: changes | ||
| if: github.repository == 'huggingface/huggingface.js' | ||
| shell: bash | ||
| env: | ||
| CURRENT_DATE: ${{ steps.prepare.outputs.CURRENT_DATE }} | ||
| run: | | ||
| set -x | ||
|
|
||
| FILE_TO_ADD="packages/ollama-utils/src/chat-template-automap.ts" | ||
|
|
||
| git status | ||
| modified_files="$(git status -s)" | ||
| echo "Modified files: ${modified_files}" | ||
| if [ -n "${modified_files}" ]; then | ||
| NEW_BRANCH="ollama-${CURRENT_DATE}" | ||
| echo "NEW_BRANCH=${NEW_BRANCH}" | ||
| echo "Changes detected, will create a new branch:" | ||
| echo "${modified_files}" | ||
| git add "${FILE_TO_ADD}" | ||
| git commit -m "ollama update ${CURRENT_DATE}" | ||
| git checkout -b "${NEW_BRANCH}" | ||
| git push -f origin "${NEW_BRANCH}" | ||
| echo "HAS_CHANGES=true" >> $GITHUB_OUTPUT | ||
| echo "NEW_BRANCH=${NEW_BRANCH}" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "No files changed, skipping..." | ||
| echo "HAS_CHANGES=false" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Create PR | ||
| if: steps.changes.outputs.HAS_CHANGES == 'true' && github.repository == 'huggingface/huggingface.js' | ||
| uses: actions/github-script@v6 | ||
| env: | ||
| CURRENT_DATE: ${{ steps.prepare.outputs.CURRENT_DATE }} | ||
| NEW_BRANCH: ${{ steps.changes.outputs.NEW_BRANCH }} | ||
| with: | ||
| script: | | ||
| const { repo, owner } = context.repo; | ||
| const currDate = process.env.CURRENT_DATE; | ||
| const newBranch = process.env.NEW_BRANCH; | ||
|
|
||
| const result = await github.rest.pulls.create({ | ||
| title: '[ollama-utils] 🤖 Auto-update chat templates (' + currDate + ')', | ||
| owner, | ||
| repo, | ||
| head: newBranch, | ||
| base: 'main', | ||
| body: [ | ||
| 'This PR is auto-generated by', | ||
| '[generate-automap.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/ollama-utils/scripts/generate-automap.ts).' | ||
| ].join('\n') | ||
| }); | ||
|
|
||
| console.log({ result }); | ||
| // github.rest.issues.addLabels({ | ||
| // owner, | ||
| // repo, | ||
| // issue_number: result.data.number, | ||
| // labels: ['feature', 'automated pr'] | ||
| // }); |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| name: Ollama Utils - Version and Release | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| newversion: | ||
| type: choice | ||
| description: "Semantic Version Bump Type" | ||
| default: patch | ||
| options: | ||
| - patch | ||
| - minor | ||
| - major | ||
|
|
||
| concurrency: | ||
| group: "push-to-main" | ||
|
|
||
| defaults: | ||
| run: | ||
| working-directory: packages/ollama-utils | ||
|
|
||
| jobs: | ||
| version_and_release: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| # Needed to push the tag and the commit on the main branch, otherwise we get: | ||
| # > Run git push --follow-tags | ||
| # remote: error: GH006: Protected branch update failed for refs/heads/main. | ||
| # remote: error: Changes must be made through a pull request. Required status check "lint" is expected. | ||
| token: ${{ secrets.BOT_ACCESS_TOKEN }} | ||
| - run: npm install -g corepack@latest && corepack enable | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: "20" | ||
| cache: "pnpm" | ||
| cache-dependency-path: | | ||
| packages/ollama-utils/pnpm-lock.yaml | ||
| # setting a registry enables the NODE_AUTH_TOKEN env variable where we can set an npm token. REQUIRED | ||
| registry-url: "https://registry.npmjs.org" | ||
| - run: pnpm install | ||
| - run: git config --global user.name machineuser | ||
| - run: git config --global user.email [email protected] | ||
| - run: | | ||
| PACKAGE_VERSION=$(node -p "require('./package.json').version") | ||
| BUMPED_VERSION=$(node -p "require('semver').inc('$PACKAGE_VERSION', '${{ github.event.inputs.newversion }}')") | ||
| # Update package.json with the new version | ||
| node -e "const fs = require('fs'); const package = JSON.parse(fs.readFileSync('./package.json')); package.version = '$BUMPED_VERSION'; fs.writeFileSync('./package.json', JSON.stringify(package, null, '\t') + '\n');" | ||
| git commit . -m "🔖 @huggingface/ollama-utils $BUMPED_VERSION" | ||
| git tag "ollama-utils-v$BUMPED_VERSION" | ||
|
|
||
| - name: "Check Deps are published before publishing this package" | ||
| run: pnpm -w check-deps tasks | ||
|
|
||
| - run: pnpm publish --no-git-checks . | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
| - run: git pull --rebase && git push --follow-tags | ||
| # hack - reuse actions/setup-node@v3 just to set a new registry | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: "20" | ||
| registry-url: "https://npm.pkg.github.com" | ||
| # Disable for now, until github supports PATs for writing github packages (https://github.com/github/roadmap/issues/558) | ||
| # - run: pnpm publish --no-git-checks . | ||
| # env: | ||
| # NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to be careful about injection when writing stuff to env in github actions - but I think it's fine in this case 👍 (no user-provided ref or branch name or file name in the vars)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I acknowledge about this class of attack. In fact, that's why I always pass variable firstly via
envand then access the environment variables in the code. So even if the user try to inject via${{ steps.changes.outputs.NEW_BRANCH }}for example, it will still be contained inside a string.In other words, a bad approach will be:
Good approach:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Please note that the above is an example. Indeed, none of the variables in the script is user-controllable as you pointed out)