commit fd80cfd8db1628bebc58de974c3e609689cbd0d2 Author: Philip Ellis <94471173+philip-ellis-sp@users.noreply.github.com> Date: Tue Sep 19 12:36:09 2023 -0500 Initial commit diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..91f749b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,32 @@ +--- +name: Bug Report +about: Create a report to help us improve. +title: "[BUG] Your Bug Report Here" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Operating System (please complete the following information):** + - OS: [e.g. Windows 10 19044.1889, Ubuntu 18.04, Mac OS Monterey 12.4] + - CLI Environment [e.g. Command Prompt, Powershell, Terminal] + - Version [e.g. 1.04] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..0204996 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: Suggest an idea for this project. +title: "[FEATURE] Your Feature Request Here " +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like.** +A clear and concise description of what you want to happen. Ex. It would be nice if [...] + +**Describe alternatives you've considered.** +A clear and concise description of any alternative solutions or features you've considered. Ex. I have seen similar features on [...] + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml new file mode 100644 index 0000000..d328d43 --- /dev/null +++ b/.github/workflows/greetings.yml @@ -0,0 +1,16 @@ +name: Greetings + +on: [pull_request_target, issues] + +jobs: + greeting: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + steps: + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: "๐ŸŽ‰ Thanks for opening your first issue here! Welcome to the community!" + pr-message: "๐ŸŽ‰ Thanks for opening this pull request! We really appreciate contributors like you! ๐Ÿ™Œ" diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..3a42989 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 SailPoint + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f08bd4 --- /dev/null +++ b/README.md @@ -0,0 +1,153 @@ + + +## How to use this template + +Update sheild urls + +* Update url for discourse, downloads, issues, current release, and contributors + +Project title and logo + +* Update project title and description +* Update project logo +* Update link to point to documentation about this project + +About the project + +* Update project screenshot +* Update the paragraph with what your project is meant to accomplish + +Getting started + +* Describe how to get started with your project +* Describe any prerequisites needed to run your project +* Describe how to install and run your project + +Discuss + +* Create a tag in our discourse forum for your project +* Update link in this section to point to the newly created tag + +After these steps are complete remove this checklist! + +[![Discourse Topics][discourse-shield]][discourse-url] +![Times Downloaded][downloads-shield] +![Issues][issues-shield] +![Latest Releases][release-shield] +![Contributor Shield][contributor-shield] + +[discourse-shield]: https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss +[discourse-url]: https://developer.sailpoint.com/discuss/tag/workflows +[downloads-shield]: https://img.shields.io/github/downloads/sailpoint-oss/api-linter/total?label=Downloads +[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/api-linter?label=Issues +[release-shield]: https://img.shields.io/github/v/release/sailpoint-oss/api-linter?label=Current%20Release +[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/api-linter?label=Contributors + +[product-screenshot]: ./assets/images/api-linter-output.png + + +
+
+ + Logo + + +

SailPoint OSS - README - Template

+ +

+ An awesome README template to jumpstart your projects! +
+ Explore the docs ยป +
+
+ +

+
+ + +## About The Project + +
+ +
+ +There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. + +Here's why: +* Your time should be focused on creating something amazing. A project that solves a problem and helps others +* You shouldn't be doing the same tasks over and over like creating a README from scratch +* You should implement DRY principles to the rest of your life :smile: + +Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template! + +Use the `BLANK_README.md` to get started. + +

(back to top)

+ + +## Getting Started + +This is an example of how you may give instructions on setting up your project locally. +To get a local copy up and running follow these simple example steps. + +### Prerequisites + +This is an example of how to list things you need to use the software and how to install them. +* npm + ```sh + npm install npm@latest -g + ``` + +### Installation + +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ + +1. Get a free API Key at [https://example.com](https://example.com) +2. Clone the repo + ```sh + git clone https://github.com/your_username_/Project-Name.git + ``` +3. Install NPM packages + ```sh + npm install + ``` +4. Enter your API in `config.js` + ```js + const API_KEY = 'ENTER YOUR API'; + ``` + +

(back to top)

+ + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag `enhancement`. +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + +

(back to top)

+ + +## Discuss +[Click Here](https://developer.sailpoint.com/dicuss/tag/{tagName}) to discuss this tool with other users. + +

(back to top)

\ No newline at end of file diff --git a/assets/images/api-linter-output.png b/assets/images/api-linter-output.png new file mode 100644 index 0000000..9590cc0 Binary files /dev/null and b/assets/images/api-linter-output.png differ