Align description of ADO and GHA #5202
Merged
Conversation
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
|
CCFenner
approved these changes
Dec 9, 2024
| description += fmt.Sprintf("%v - name: your preferred name for the step\n", spacingTabBox) | ||
| description += fmt.Sprintf("%v uses: SAP/project-piper-action@main\n", spacingTabBox) | ||
| description += fmt.Sprintf("%v - name: %v\n", spacingTabBox, stepData.Metadata.Name) | ||
| description += fmt.Sprintf("%v uses: SAP/project-piper-action@releaseCommitSHA\n", spacingTabBox) |
There was a problem hiding this comment.
Let's use the version here, I think that's more intuitive to use.
Suggested change
| description += fmt.Sprintf("%v uses: SAP/project-piper-action@releaseCommitSHA\n", spacingTabBox) | |
| description += fmt.Sprintf("%v uses: SAP/project-piper-action@1.23.0\n", spacingTabBox) |
Would be interesting to know if we can use @1 as well.
| @@ -73,8 +74,8 @@ func createDescriptionSection(stepData *config.StepData) string { | |||
| description += headlineGHA | |||
| description += fmt.Sprintf("%v```\n", spacingTabBox) | |||
| description += fmt.Sprintf("%vsteps:\n", spacingTabBox) | |||
| description += fmt.Sprintf("%v - name: your preferred name for the step\n", spacingTabBox) | |||
| description += fmt.Sprintf("%v uses: SAP/project-piper-action@main\n", spacingTabBox) | |||
| description += fmt.Sprintf("%v - uses: SAP/project-piper-action@releaseCommitSHA\n", spacingTabBox) | |||
There was a problem hiding this comment.
We can
It seems the recommendation from GH team is to use SHA as it is safer
There was a problem hiding this comment.
Error: Unable to resolve action `SAP/project-piper-action@1`, unable to find version `1`
|
/it-go |
maxatsap
added a commit
to maxatsap/jenkins-library
that referenced
this pull request
Jan 10, 2025
…ix-fix * origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...
maxatsap
added a commit
to maxatsap/jenkins-library
that referenced
this pull request
Jan 10, 2025
* origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...
maxatsap
added a commit
to maxatsap/jenkins-library
that referenced
this pull request
Jan 10, 2025
…fig-fix * origin/master: (36 commits) Revert changes done to release action (SAP#5228) Update release-go.yml (SAP#5227) Remove README and CONTRIBUTING files from release 3rd try (SAP#5226) fix(setupCommonPipelineEnvironment): handling tags from scm info (SAP#5219) Remove README and CONTRIBUTING files from release 2nd try (SAP#5225) [CxONE] Improve report: add Low findings; Proposed Not Exploitable state (SAP#5223) Remove README and CONTRIBUTING files from release (SAP#5221) fix(naming): Rename Trust Engine to System Trust (SAP#5217) abapEnvironmentAssemblePackages Check for Build Errors (SAP#5214) docs: fix npmExuceteTests documentation formatting issues (SAP#5218) feat: Introduce new npmExecuteTests step (SAP#5124) fix(cloudFoundryDeploy): argument list too long (SAP#5216) Revert "Fix deployment failure with CF if password contains special char (SAP#5197)" (SAP#5215) chore(trustengine): Rename Trust Engine to System Trust in logs and docs (SAP#5210) Fix deployment failure with CF if password contains special char (SAP#5197) Update go version to 1.23 and removed some helper methods in favor of STD library (SAP#5200) Added validation for buildTool and buildDescriptorFile (SAP#5193) Unstash class files for Compliance stage (SAP#5192) (SAP#5204) fix(documentation): check param for jenkinsParams before appending Jenkins-specific text (SAP#5203) Align description of ADO and GHA (SAP#5202) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR aligns the sample step description for ADO and GHA .
I have added flags parameter for both as I think it will be easier for users to follow documentation with this parameter
Checklist