Skip to content

Commit

Permalink
docs: add overview page and GitHub link
Browse files Browse the repository at this point in the history
  • Loading branch information
shark300 authored and shark300 committed May 6, 2022
1 parent f707863 commit 2756ddd
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 3 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 shark300

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
## Benefits of the Jira Issue Extractor Azure DevOps Marketplace Extension

### Jira Key Publishing From Multiple Sources

JiraIssueKeyExtractor task extracts Jira Keys from Pull Request's branch name and commits of the build. The extracted
values will be propagated as `JIRA_KEYS` environment variable.

## Jira Issue Extractor Azure DevOps Marketplace Extension Details

This extension provides Pull Request's branch name and commits analysis and publishing Jira Keys. IndiviualCI is the
only supported way of extraction.

Integration sample for Build Pipeline:

```yaml
jobs:
- job: Build

steps:
- checkout: self
clean: true
- task: JiraIssueKeyExtractor@1
env:
SYSTEM_ACCESSTOKEN: $(System.AccessToken)
condition: eq(variables['Build.Reason'], 'IndividualCI')
```
[![VSTSExtension-JiraIssueExtractor CI](https://github.com/shark300/VSTSExtension-JiraIssueExtractor/actions/workflows/ci.yml/badge.svg)](https://github.com/shark300/VSTSExtension-JiraIssueExtractor/actions/workflows/ci.yml)
2 changes: 1 addition & 1 deletion tasks/extractor/task.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"version": {
"Major": 1,
"Minor": 0,
"Patch": 2
"Patch": 3
},
"instanceNameFormat": "Extract Jira keys",
"inputs": [],
Expand Down
13 changes: 11 additions & 2 deletions vss-extension.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"manifestVersion": 1,
"id": "jira-issue-extractor",
"name": "Jira Issue Extractor",
"version": "1.0.2",
"version": "1.0.3",
"publisher": "AttilaHajdu",
"targets": [
{
Expand All @@ -28,5 +28,14 @@
"name": "tasks/extractor"
}
}
]
],
"content": {
"details": {
"path": "README.md"
}
},
"repository": {
"type": "git",
"uri": "https://github.com/shark300/VSTSExtension-JiraIssueExtractor"
}
}

0 comments on commit 2756ddd

Please sign in to comment.