Skip to content

Commit

Permalink
Merge pull request #469 from inspec/boilerplate
Browse files Browse the repository at this point in the history
Add github templates & fix the expeditor version bump script
  • Loading branch information
tas50 authored Jul 1, 2019
2 parents f6413ef + f624ae2 commit 5e13759
Show file tree
Hide file tree
Showing 20 changed files with 105 additions and 1,607 deletions.
5 changes: 5 additions & 0 deletions .expeditor/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,8 @@ promote:
actions:
- built_in:rollover_changelog
- built_in:publish_rubygems

pipelines:
- verify:
description: Pull Request validation tests
public: true
4 changes: 2 additions & 2 deletions .expeditor/update_version.sh
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#!/bin/sh
#!/bin/bash
#
# After a PR merge, Chef Expeditor will bump the PATCH version in the VERSION file.
# It then executes this file to update any other files/components with that new version.
#

set -evx

sed -i -r "s/VERSION = '.*'/VERSION = '$(cat VERSION)'/" lib/train/version.rb
sed -i -r "s/VERSION = \".*\"/VERSION = \"$(cat VERSION)\"/" lib/train/version.rb

# Once Expeditor finshes executing this script, it will commit the changes and push
# the commit as a new tag corresponding to the value in the VERSION file.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: � Bug Report
about: If something isn't working as expected �.
labels: "Status: Untriaged"
---

# Version:

[Version of the project installed]

# Environment:

[Details about the environment such as the Operating System, cookbook details, etc...]

# Scenario:

[What you are trying to achieve and you can't?]

# Steps to Reproduce:

[If you are filing an issue what are the things we need to do in order to repro your problem?]

# Expected Result:

[What are you expecting to happen as the consequence of above reproduction steps?]

# Actual Result:

[What actually happens after the reproduction steps?]
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/DESIGN_PROPOSAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Design Proposal
about: I have a significant change I would like to propose and discuss before starting
labels: "Status: Untriaged"
---

### When a Change Needs a Design Proposal

A design proposal should be opened any time a change meets one of the following qualifications:

- Significantly changes the user experience of a project in a way that impacts users.
- Significantly changes the underlying architecture of the project in a way that impacts other developers.
- Changes the development or testing process of the project such as a change of CI systems or test frameworks.

### Why We Use This Process

- Allows all interested parties (including any community member) to discuss large impact changes to a project.
- Serves as a durable paper trail for discussions regarding project architecture.
- Forces design discussions to occur before PRs are created.
- Reduces PR refactoring and rejected PRs.

---

<!--- Proposal description and rationale. -->

## Motivation

<!---
As a <<user_profile>>,
I want to <<functionality>>,
so that <<benefit>>.
-->

## Specification

<!--- A detailed description of the planned implementation. -->

## Downstream Impact

<!--- Which other tools will be impacted by this work? -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/ENHANCEMENT_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: 🚀 Enhancement Request
about: I have a suggestion (and may want to implement it 🙂)!
labels: "Status: Untriaged"
---

### Describe the Enhancement:
<!--- What you are trying to achieve that you can't? -->

### Describe the Need:
<!--- What kind of user do you believe would utilize this enhancement, and how many users might want this functionality -->

### Current Alternative
<!--- Is there a current alternative that you can utilize to workaround the lack of this enhancement -->

### Can We Help You Implement This?:
<!--- The best way to ensure your enhancement is built is to help implement the enhancement yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT_QUESTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: 🤗 Support Question
about: If you have a question 💬, please check out our Slack!
---

We use GitHub issues to track bugs and feature requests. If you need help please post to our Mailing List or join the Chef Community Slack.

* Chef Community Slack at http://community-slack.chef.io/.
* Chef Mailing List https://discourse.chef.io/

Support issues opened here will be closed and redirected to Slack or Discourse.
19 changes: 0 additions & 19 deletions .github/labels-in-terraform/README.md

This file was deleted.

69 changes: 0 additions & 69 deletions .github/labels-in-terraform/labels-aspects.tf

This file was deleted.

107 changes: 0 additions & 107 deletions .github/labels-in-terraform/labels-components.tf

This file was deleted.

34 changes: 0 additions & 34 deletions .github/labels-in-terraform/labels-expeditor.tf

This file was deleted.

Loading

0 comments on commit 5e13759

Please sign in to comment.