Skip to content

docs: document existing workflows#31

Merged
scott45 merged 3 commits intodevfrom
document-workflows
Sep 3, 2024
Merged

docs: document existing workflows#31
scott45 merged 3 commits intodevfrom
document-workflows

Conversation

@scott45
Copy link
Copy Markdown
Contributor

@scott45 scott45 commented Sep 2, 2024

SPDX-License-Identifier: Apache-2.0

What did we change?

  • Document existing workflows

How was it tested?

  • Locally
  • Development Environment
  • Not needed, changes very basic
  • Husky successfully run
  • Unit tests passing and Documentation done

@scott45 scott45 added the documentation Improvements or additions to documentation label Sep 2, 2024
@scott45 scott45 self-assigned this Sep 2, 2024
Comment thread workflow-docs/bench.md Fixed
Comment thread workflow-docs/codacy.md Fixed
Comment thread workflow-docs/codeql.md Fixed

`push`:

`branches`: [ "dev", "main" ] - The workflow triggers when code is pushed to the dev or main branches.

Check warning

Code scanning / Remark-lint (reported by Codacy)

Warn when references to undefined definitions are found.

[no-undefined-references] Found reference to undefined definition

`pull_request`:

`branches`: [ "dev" ] - The workflow triggers when a pull request is opened or updated against the dev branch.

Check warning

Code scanning / Remark-lint (reported by Codacy)

Warn when references to undefined definitions are found.

[no-undefined-references] Found reference to undefined definition
Copy link
Copy Markdown

@github-advanced-security github-advanced-security AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdownlint (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@scott45 scott45 merged commit a0062b3 into dev Sep 3, 2024
@scott45 scott45 deleted the document-workflows branch September 3, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants