Skip to content

Commit

Permalink
update documentation v0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
haboumrad committed Aug 20, 2023
1 parent 9c17252 commit cd33a26
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,17 +84,19 @@ The jira integration relies on the basic auth atlassian integration.
More information about how obtaining the JIRA_USER and JIRA_TOKEN cab ne found d in the atlassian documentation at the following location: https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/


| variable | Description | Example |
|------------|-------------|-------------------------------|
| JIRA_USER | jira user | email |
| JIRA_TOKEN | jira token | password |
| JIRA_URL | jira url | http://your-jira-instance.com |

| variable | Description | Example |
|------------------------------|--------------------------------------------------------|-------------------------------|
| JIRA_USER | jira user | email |
| JIRA_TOKEN | jira token | password |
| JIRA_URL | jira url | http://your-jira-instance.com |
| JIRA_DEPLOYMENT_IMPACT_FIELD | filed name used in jira to descriebe deployment impact | custom_filed_1234 |
JIRA_DEPLOYMENT_IMPACT_FIELD
Sample file
```
JIRA_USER=email
JIRA_TOKEN=password
JIRA_URL=http://your-jira-instance.com
JIRA_DEPLOYMENT_IMPACT_FIELD=custom_field_1234
```

###~/.changelog/<CONTEXT_NAME>/.env.confluence-bom-change-log-exporter-adapter
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@haboumrad/bom-changelog",
"version": "0.1.0",
"version": "0.1.1",
"description": "changelog generation using github, jira and confluence",
"author": "",
"private": false,
Expand Down

0 comments on commit cd33a26

Please sign in to comment.