-
-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: fix add missing comments #409
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b84d4ec
chore: fix add missing comments
jackton1 1fa788b
Merge b84d4ecca608ab6123149ad0b62dcb58b01809ee into cd60cddc3953728a1…
jackton1 f9f7231
chore: Updated coverage badge.
actions-user 31eb041
Merge f9f7231fcb22ec1c91b60a86c9afdb3b128ca50e into cd60cddc3953728a1…
jackton1 0f003ec
Formatted code.
github-actions[bot] 84b9cab
Merge 0f003ece9b4659cf1309a5e81f3dc534136152ef into cd60cddc3953728a1…
jackton1 96f6a43
Updated README.
github-actions[bot] 5bd8cb3
Fixed error with format action
jackton1 93c34cb
Merge branch 'main' into chore/fix-add-missing-comments
jackton1 39668ba
Merge 93c34cbb978f72ea4875d832506721a4288a1370 into fd86fa3c6a7d50fd7…
jackton1 57a2454
Formatted code.
github-actions[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,77 @@ | ||
// Package internal/constants contains all internal constants | ||
/* | ||
Copyright © 2021 Tonye Jack <jtonye@ymail.com> | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
package internal | ||
|
||
import "fmt" | ||
|
||
// InputsHeader represents the markdown header of inputs | ||
const InputsHeader = "## Inputs" | ||
|
||
// OutputsHeader represents the markdown header of outputs | ||
const OutputsHeader = "## Outputs" | ||
|
||
// SecretsHeader represents the markdown header of secrets | ||
const SecretsHeader = "## Secrets" | ||
|
||
// AutoDocStart placeholder that represents the start of the input table | ||
const AutoDocStart = "<!-- AUTO-DOC-%s:START - Do not remove or modify this section -->" | ||
|
||
// AutoDocEnd placeholder that represents the end of the input table | ||
const AutoDocEnd = "<!-- AUTO-DOC-%s:END -->" | ||
|
||
// PipeSeparator represents the separator used for the distinguishing between columns | ||
const PipeSeparator = "|" | ||
|
||
// NewLineSeparator used for splitting lines | ||
const NewLineSeparator = "\n" | ||
|
||
// InputAutoDocStart is the start of the input | ||
var InputAutoDocStart = fmt.Sprintf(AutoDocStart, "INPUT") | ||
|
||
// InputAutoDocEnd is the end of the input | ||
var InputAutoDocEnd = fmt.Sprintf(AutoDocEnd, "INPUT") | ||
|
||
// OutputAutoDocStart is the start of the output | ||
var OutputAutoDocStart = fmt.Sprintf(AutoDocStart, "OUTPUT") | ||
|
||
// OutputAutoDocEnd is the end of the output | ||
var OutputAutoDocEnd = fmt.Sprintf(AutoDocEnd, "OUTPUT") | ||
|
||
// SecretsAutoDocStart is the start of the secrets | ||
var SecretsAutoDocStart = fmt.Sprintf(AutoDocStart, "SECRETS") | ||
|
||
// SecretsAutoDocEnd is the end of the secrets | ||
var SecretsAutoDocEnd = fmt.Sprintf(AutoDocEnd, "SECRETS") | ||
|
||
// action.yml | ||
|
||
// DefaultActionInputColumns default values | ||
var DefaultActionInputColumns = []string{"Input", "Type", "Required", "Default", "Description"} | ||
|
||
// DefaultActionOutputColumns default values | ||
var DefaultActionOutputColumns = []string{"Output", "Type", "Description"} | ||
|
||
|
||
// Reusable workflows | ||
|
||
// DefaultReusableSecretColumns default values | ||
var DefaultReusableSecretColumns = []string{"Secret", "Required", "Description"} | ||
|
||
// DefaultReusableOutputColumns default values | ||
var DefaultReusableOutputColumns = []string{"Output", "Value", "Description"} | ||
|
||
// DefaultReusableInputColumns default values | ||
var DefaultReusableInputColumns = []string{"Input", "Type", "Required", "Default", "Description"} | ||
var DefaultReusableInputColumns = []string{"Input", "Type", "Required", "Default", "Description"} |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,23 @@ | ||
//Package types contains all defined types | ||
/* | ||
Copyright © 2021 Tonye Jack <jtonye@ymail.com> | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
package types | ||
|
||
// Documentation is the interface for Action and Reusable | ||
type Documentation interface { | ||
GetData() error | ||
RenderOutput() error | ||
} | ||
} |
Oops, something went wrong.
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.
Check warning
Code scanning / Revive (reported by Codacy)
package comment should be of the form "Package internal ..."