You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`GITHUB_TOKEN`| GitHub token for MegaLinter GitHub integration | Yes |
11
14
12
-
_**Edit this area to include a custom title and description.**_
13
-
14
-
Following variables needs to be set to correct clone the megalinter image. They are personal API keys from Docker Hub.
15
-
16
-
```bash
17
-
$DOCKERHUB_USERNAME
18
-
$DOCKERHUB_PASSWORD
19
-
```
20
-
21
-
Setup GitHub auth within Megalinter orb by setting following environment variable:
22
-
23
-
```bash
24
-
$GITHUB_TOKEN
25
-
```
26
-
27
-
---
15
+
### Security Notes
16
+
- GitHub Token: Use a token with minimal required permissions (read-only access recommended)
17
+
- Docker Hub: Consider using a restricted access token instead of password
18
+
- For CircleCI security best practices, see [Using Contexts](https://circleci.com/docs/contexts/)
28
19
29
20
## Resources
30
21
31
-
[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/<namespace>/<orb-name>) - The official registry page of this orb for all versions, executors, commands, and jobs described.
22
+
[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/RelativeSure/megalinter) - The official registry page of this orb for all versions, executors, commands, and jobs described.
32
23
33
24
[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs.
34
25
26
+
All examples are shown in [the examples folder](src/examples/)
27
+
35
28
### How to Contribute
36
29
37
-
We welcome [issues](https://github.com/<organization>/<project-name>/issues) to and [pull requests](https://github.com/<organization>/<project-name>/pulls) against this repository!
30
+
We welcome [issues](https://github.com/RelativeSure/circleci-megalinter-orb/issues) and [pull requests](https://github.com/RelativeSure/circleci-megalinter-orb/pulls) against this repository!
31
+
32
+
#### Contribution Guidelines
33
+
1. Fork and clone the repository
34
+
2. Create a new branch for your changes
35
+
3. Make your changes following our coding standards
36
+
4. Test your changes locally
37
+
5. Submit a pull request with a clear description of the changes
38
38
39
-
### How to Publish An Update
39
+
For more details, see our [Contributing Guide](CONTRIBUTING.md).
40
+
41
+
### How to Publish an Update
40
42
41
43
1. Merge pull requests with desired changes to the main branch.
42
44
- For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).
43
45
2. Find the current version of the orb.
44
-
- You can run `circleci orb info <namespace>/<orb-name> | grep "Latest"` to see the current version.
45
-
3. Create a [new Release](https://github.com/<organization>/<project-name>/releases/new) on GitHub.
46
+
- You can run `circleci orb info RelativeSure/megalinter | grep "latest"` to see the current version.
47
+
3. Create a [new release](https://github.com/RelativeSure/circleci-megalinter-orb/releases/new) on GitHub.
46
48
- Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0)
47
49
- We will have an opportunity to change this before we publish if needed after the next step.
48
-
a. Click _"+ Auto-generate release notes"_.
50
+
- Click _"+ Auto-generate release notes"_.
49
51
- This will create a summary of all of the merged pull requests since the previous release.
50
52
- If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
51
53
4. Now ensure the version tag selected is semantically accurate based on the changes included.
@@ -56,21 +58,18 @@ We welcome [issues](https://github.com/<organization>/<project-name>/issues) to
56
58
57
59
Prerequisites:
58
60
59
-
- An initial sevmer deployment must be performed in order for Development orbs to be published and seen in the [Orb Registry](https://circleci.com/developer/orbs).
61
+
- An initial semver deployment must be performed in order for development orbs to be published and seen in the [Orb Registry](https://circleci.com/developer/orbs).
60
62
61
-
A [Development orb](https://circleci.com/docs/orb-concepts/#development-orbs) can be created to help with rapid development or testing. To create a Development orb, change the `orb-tools/publish` job in `test-deploy.yml` to be the following:
63
+
A [Development Orb](https://circleci.com/docs/orb-concepts/#development-orbs) can be created to help with rapid development or testing. To create a development orb, change the `orb-tools/publish` job in `test-deploy.yml` to be the following:
62
64
63
65
```yaml
64
66
- orb-tools/publish:
65
-
orb_name: <namespace>/<orb-name>
67
+
orb_name: RelativeSure/megalinter
66
68
vcs_type: << pipeline.project.type >>
67
69
pub_type: dev
68
70
# Ensure this job requires all test jobs and the pack job.
69
71
requires:
70
72
- orb-tools/pack
71
73
- megalinter/megalinter
72
-
context: <publishing-context>
74
+
context: < organization context>
73
75
filters: *filters
74
-
```
75
-
76
-
The job output will contain a link to the Development orb Registry page. The parameters `enable_pr_comment` and `github_token` can be set to add the relevant publishing information onto a pull request. Please refer to the [orb-tools/publish](https://circleci.com/developer/orbs/orb/circleci/orb-tools#jobs-publish) documentation for more information and options.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?v=4&size=40){kind=avatar}
0 commit comments