From d088781bb0a7999ee43918fe51d0f0cda17df8b4 Mon Sep 17 00:00:00 2001 From: jdfiguer Date: Thu, 30 May 2024 14:12:53 -0400 Subject: [PATCH 1/3] Fix #772, Adds version updates to document workflows --- .github/workflows/build-deploy-doc.yml | 12 ++++++------ .github/workflows/build-documentation.yml | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build-deploy-doc.yml b/.github/workflows/build-deploy-doc.yml index fafaeb6f1..77c51c8a9 100644 --- a/.github/workflows/build-deploy-doc.yml +++ b/.github/workflows/build-deploy-doc.yml @@ -125,7 +125,7 @@ jobs: mv build/docs/${{ matrix.target }}/${{ matrix.target }}-warnings.log . - name: Archive Document Build Logs - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: ${{ matrix.target }}_doc_build_logs path: | @@ -165,9 +165,9 @@ jobs: - name: Deploy to GitHub if: ${{ inputs.deploy == true }} - uses: JamesIves/github-pages-deploy-action@3.7.1 + uses: JamesIves/github-pages-deploy-action@v4 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: deploy - SINGLE_COMMIT: true + token: ${{ secrets.GITHUB_TOKEN }} + branch: gh-pages + folder: deploy + single-commit: true diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 5cbfd04b6..9435fc918 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -62,7 +62,7 @@ jobs: steps: - uses: actions/checkout@v4 - - uses: actions/download-artifact@v3 + - uses: actions/download-artifact@v4 - name: Display structure of downloaded files run: ls -R @@ -71,9 +71,9 @@ jobs: run: mkdir deploy; mv */*.pdf deploy - name: Deploy to GitHub - uses: JamesIves/github-pages-deploy-action@3.7.1 + uses: JamesIves/github-pages-deploy-action@v4 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: deploy - SINGLE_COMMIT: true + token: ${{ secrets.GITHUB_TOKEN }} + branch: gh-pages + folder: deploy + single-commit: true From 1a68390c38ab277321ff348ffbedfa7c0be52e70 Mon Sep 17 00:00:00 2001 From: Avi Weiss Date: Fri, 22 Sep 2023 11:18:08 +1000 Subject: [PATCH 2/3] Fix #706, Update broken TOC links in CONTRIBUTING.md --- .github/pull_request_template.md | 2 +- .github/workflows/build-run-app.yml | 2 +- .github/workflows/codeql-analysis.yml | 2 +- CONTRIBUTING.md | 60 +++++++++++++-------------- 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5268e394f..3fb416a4d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ A clear and concise description of what the contribution is. **Testing performed** Steps taken to test the contribution: 1. Build steps '...' -1. Execution steps '...' +2. Execution steps '...' **Expected behavior changes** A clear and concise description of how this contribution will change behavior and level of impact. diff --git a/.github/workflows/build-run-app.yml b/.github/workflows/build-run-app.yml index 80cf328d3..4d94e9980 100644 --- a/.github/workflows/build-run-app.yml +++ b/.github/workflows/build-run-app.yml @@ -49,7 +49,7 @@ jobs: echo "APP_UPPER=$(echo ${{ inputs.app-name }} | sed 's/[a-z]/\U&/g')" >> $GITHUB_ENV echo "APP_LOWER=$(echo ${{ inputs.app-name }} | sed 's/[A-Z]/\L&/g')" >> $GITHUB_ENV - - name: Set up start string for verificaiton + - name: Set up start string for verification run: | if [[ "${{ inputs.startup-string }}" == '' ]]; then echo "START_STRING=$APP_UPPER Initialized." >> $GITHUB_ENV diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 8d86bdc82..7c5c41aa8 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -7,7 +7,7 @@ on: jobs: codeql: uses: nasa/cFS/.github/workflows/codeql-reusable.yml@main - with: + with: component-path: cFS make: make -j8 test: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c81a0ea60..0460d1c48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,36 +3,36 @@ So you'd like to contribute to cFS? Below are some guidelines for contributors to follow. Contributions come in all shapes and sizes. We appreciate your help with documentation, unit tests, framework code, continuous-integration, or simply reporting bugs and improvement ideas. We can't promise that we'll accept every suggestion or fix every bug in a timely manner but we'll respond to you as quickly as possible. -* [Code of Conduct](#CodeofConduct) -* [Ways to Contribute](#WaystoContribute) - * [Discussions and Questions](#DiscussionsandQuestions) - * [Security Vulnerabilities](#SecurityVulnerabilities) - * [Bug Reports](#BugReports) - * [Before Reporting a Bug](#BeforeReportingaBug) - * [Reporting a Bug](#ReportingaBug) - * [What Happens to my Bug Report?](#WhatHappenstomyBugReport) - * [New Feature Requests](#NewFeatureRequests) - * [Before Requesting a New Feature](#BeforeRequestingaNewFeature) - * [Requesting a New Feature](#RequestingaNewFeature) - * [What Happens to my Feature Request?](#WhatHappenstomyFeatureRequest) - * [Issue Trackers for cFS Components](#IssueTrackersforcFSComponents) - * [cFS-Framework Components](#cFS-FrameworkComponents) - * [Lab Apps](#LabApps) - * [Tools](#Tools) - * [Other cFS Apps](#OthercFSApps) - * [Pull Requests](#PullRequests) - * [Contributor License Agreement (CLA)](#ContributorLicenseAgreementCLA) - * [Before starting your Pull Request](#BeforestartingyourPullRequest) - * [Creating a Pull Request](#CreatingaPullRequest) - * [What Happens to My Pull Request?](#WhatHappenstoMyPullRequest) -* [Writing High-Quality Code](#WritingHigh-QualityCode) - * [Using GitHub Actions Workflows](#UsingGitHubActionsWorkflows) - * [View Failed Workflows](#ViewFailedWorkflows) - * [View Workflow Results](#ViewWorkflowResults) - * [Configure Workflows](#ConfigureWorkflows) - * [cFS Workflows](#cFSWorkflows) - * [Git Commit Guidelines](#GitCommitGuidelines) - * [Working with git commits](#Workingwithgitcommits) +- [Code of Conduct](#code-of-conduct) +- [Ways to Contribute](#ways-to-contribute) + - [Discussions and Questions](#discussions-and-questions) + - [Security Vulnerabilities](#security-vulnerabilities) + - [Bug Reports](#bug-reports) + - [Before Reporting a Bug](#before-reporting-a-bug) + - [Reporting a Bug](#reporting-a-bug) + - [What Happens to my Bug Report?](#what-happens-to-my-bug-report) + - [New Feature Requests](#new-feature-requests) + - [Before Requesting a New Feature](#before-requesting-a-new-feature) + - [Requesting a New Feature](#requesting-a-new-feature) + - [What Happens to my Feature Request?](#what-happens-to-my-feature-request) + - [Issue Trackers for cFS Components](#issue-trackers-for-cfs-components) + - [cFS-Framework Components](#cfs-framework-components) + - [Lab Apps](#lab-apps) + - [Tools](#tools) + - [Other cFS Apps](#other-cfs-apps) + - [Pull Requests](#pull-requests) + - [Contributor License Agreement (CLA)](#contributor-license-agreement-cla) + - [Before starting your Pull Request](#before-starting-your-pull-request) + - [Creating a Pull Request](#creating-a-pull-request) + - [What Happens to My Pull Request?](#what-happens-to-my-pull-request) +- [Writing High-Quality Code](#writing-high-quality-code) + - [Using GitHub Actions Workflows](#using-github-actions-workflows) + - [View Failed Workflows](#view-failed-workflows) + - [View Workflow Results](#view-workflow-results) + - [Configure Workflows](#configure-workflows) + - [cFS Workflows](#cfs-workflows) + - [Git Commit Guidelines](#git-commit-guidelines) + - [Working with git commits](#working-with-git-commits)