Pipeline for creating supported modifier markdown #114
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
| name: Pipeline for creating supported modifier markdown | |
| on: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '0 21 * * *' | |
| jobs: | |
| updateMarkDown: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone Sigma | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: SigmaHQ/sigma | |
| path: sigma-repo | |
| token: ${{ secrets.GITHUB_TOKEN }} ## This is necessary for executing on a local machine by act(Local GitHub Action Runner). We have to specify the github token explicitly. | |
| - name: Clone hayabusa rule repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: Yamato-Security/hayabusa-rules | |
| path: hayabusa-rules-repo | |
| token: ${{ secrets.GITHUB_TOKEN }} ## This is necessary for executing on a local machine by act(Local GitHub Action Runner). We have to specify the github token explicitly. | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| architecture: 'x64' | |
| - name: Setup Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| - name: Create markdown | |
| run: | | |
| cd hayabusa-rules-repo/scripts/supported_modifiers_check | |
| poetry install --no-root | |
| poetry run python supported-modifier.py ../../../sigma-repo ../../../hayabusa-rules-repo ../../doc/SupportedSigmaFieldModifiers.md | |
| - name: Create Text | |
| id: create-text | |
| run: | | |
| pushd hayabusa-rules-repo | |
| echo "action_date=$(date '+%Y-%m-%d %H:%M:%S')" >> $GITHUB_ENV | |
| echo "change_exist=true" >> $GITHUB_ENV | |
| git_new=$(git diff --name-status --diff-filter=AC) | |
| git_mod=$(git diff --name-status --diff-filter=MR) | |
| git_del=$(git diff --name-status --diff-filter=D) | |
| is_rule_changed=$(git status) | |
| if [ "${is_rule_changed}" =~ nothing\sto\scommit ]; then | |
| echo "change_exist=false" >> $GITHUB_ENV | |
| else | |
| echo "<details><summary>New files</summary>" >> ../changed_rule.logs | |
| echo "${git_new}" >> ../changed_rule.logs | |
| echo "</details>" >> ../changed_rule.logs | |
| echo "<details><summary>Modified files</summary>" >> ../changed_rule.logs | |
| echo "${git_mod}" >> ../changed_rule.logs | |
| echo "</details>" >> ../changed_rule.logs | |
| echo "<details><summary>Deleted files</summary>" >> ../changed_rule.logs | |
| echo "${git_del}" >> ../changed_rule.logs | |
| echo "</details>" >> ../changed_rule.logs | |
| fi | |
| popd | |
| - name: Create Pull Request | |
| if: env.change_exist == 'true' | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v4 | |
| with: | |
| path: hayabusa-rules-repo | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| commit-message: Sigma Rule Supported Modifier Update (${{ env.action_date }}) | |
| branch: auto-sigma-supported-modifier-update | |
| delete-branch: true | |
| title: '[Auto] Sigma Rule Supported Modifier Update report(${{ env.action_date }})' ### If a PR with the same name already exists, this github action library will not create a new pull request but it will update the PR with the same name. Therefore I added the date to the pull request's title so it creates a new PR. | |
| branch-suffix: timestamp ### I use this field in order to avoid name duplication. If the pull request which is related to the same branch exists, the pull request is not newly created but is updated. So the next step will be skipped due to its if-field | |
| body: | | |
| ${{ env.action_date }} Update report | |
| - name: Enable Pull Request Automerge | |
| if: steps.cpr.outputs.pull-request-operation == 'created' # This only runs if there were sigma rules updates and a new PR was created. | |
| uses: peter-evans/enable-pull-request-automerge@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| pull-request-number: ${{ steps.cpr.outputs.pull-request-number }} | |
| merge-method: squash | |
| - name: upload change log | |
| if: env.change_exist == 'true' | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: changed_rule_log | |
| path: ${{ github.workspace }}/changed_rule.logs | |
| retention-days: 30 |