Prepare open source release

.github/workflows/ci.yaml

@@ -0,0 +1,135 @@
+name: ci
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      'v*'
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  # This is a super hacky way to get this into a place that can actually be
+  # used by downstream jobs because YAML values don't allow shell
+  # interpolation, only github expression interpolation
+  store-sha8:
+    name: Store The Short Hash
+    runs-on: ubuntu-latest
+    outputs:
+      sha8: ${{ steps.calc-short.outputs.sha8 }}
+    steps:
+      - name: Calculate Short Hash
+        id: calc-short
+        run: echo "::set-output name=sha8::${GITHUB_SHA::8}"
+
+
+  build:
+    name: Build
+    needs: [store-sha8]
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        go-version: ['1.14']
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: Set artifact name
+      run: echo "::set-env name=name::aterm-${{ needs.store-sha8.outputs.sha8 }}-$(uname -s | tr '[:upper:]' '[:lower:]')"
+
+    - name: Set up Go 1.x
+      uses: actions/setup-go@v2
+      with:
+        go-version: ${{ matrix.go-version }}
+      id: go
+
+    - name: Install go tools
+      run: |
+        go get golang.org/x/lint/golint
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2 
+    - name: Build Repo
+      run: go build -v ./...
+
+    - name: gofmt
+      run: |
+        GOFMTOUT=$(gofmt -l .)
+        if [[ ! -z "${GOFMTOUT}" ]]; then
+          echo "FATAL: gofmt violation(s), please fix"
+          echo $GOFMTOUT
+          exit -1
+        fi
+
+    - name: go vet
+      run: go vet ./...
+
+    - name: golint
+      run: golint ./...
+
+    - name: Test
+      run: go test -v ./...
+
+    - name: Build Executable
+      run: go build -o cmd/aterm/aterm cmd/aterm/*.go
+
+    - name: package
+      run: |
+        mkdir dist
+        cp cmd/aterm/aterm dist/
+        cp cmd/aterm/example.config.yaml dist/config.yaml
+        cp LICENSE dist/LICENSE
+        cp README.md dist/README.md
+
+    - name: Archive production artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: ${{ env.name }}
+        path: dist
+
+  release:
+    name: Create GitHub Release
+    if: contains(github.ref, 'tags/v')
+    needs: [store-sha8, build]
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{ steps.create-release.outputs.upload_url }}
+
+    steps:
+      - name: Create Release
+        id: create-release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: false
+          prerelease: false
+
+  publish:
+    if: contains(github.ref, 'tags/v')
+    needs: [store-sha8, build, release]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        platform: [darwin, linux]
+    steps:
+      - name: Set Version
+        run: echo "::set-env name=version::$(echo ${{ github.ref }} | cut -d'/' -f3 | cut -c2-)"
+      - name: Download Previous Artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: aterm-${{ needs.store-sha8.outputs.sha8 }}-${{ matrix.platform }}
+          path: aterm-${{ env.version }}-${{ matrix.platform }}
+      - name: Produce Zip
+        run: zip -r aterm-${{ env.version }}-${{ matrix.platform }}.zip aterm-${{ env.version }}-${{ matrix.platform }}
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release.outputs.upload_url }}
+          asset_path: aterm-${{ env.version }}-${{ matrix.platform }}.zip
+          asset_name: aterm-${{ env.version }}-${{ matrix.platform }}.zip
+          asset_content_type: application/zip

.gitignore

@@ -0,0 +1,13 @@
+# Junk files
+.DS_Store
+.*swp
+
+# IDE support
+.vscode
+.idea
+
+# Private Files
+conf.yaml
+
+# Others
+cmd/aterm/aterm

Code-of-Conduct.md

@@ -0,0 +1,52 @@
+# Verizon Media Open Source Code of Conduct
+
+## Summary
+This Code of Conduct is our way to encourage good behavior and discourage bad behavior in our open source projects. We invite participation from many people to bring different perspectives to our projects. We will do our part to foster a welcoming and professional environment free of harassment. We expect participants to communicate professionally and thoughtfully during their involvement with this project. 
+
+Participants may lose their good standing by engaging in misconduct. For example: insulting, threatening, or conveying unwelcome sexual content. We ask participants who observe conduct issues to report the incident directly to the project's Response Team at opensource-conduct@verizonmedia.com. Verizon Media will assign a respondent to address the issue. We may remove harassers from this project. 
+
+This code does not replace the terms of service or acceptable use policies of the websites used to support this project. We acknowledge that participants may be subject to additional conduct terms based on their employment which may govern their online expressions.
+
+## Details
+This Code of Conduct makes our expectations of participants in this community explicit.
+* We forbid harassment and abusive speech within this community.
+* We request participants to report misconduct to the project’s Response Team.
+* We urge participants to refrain from using discussion forums to play out a fight.
+
+### Expected Behaviors
+We expect participants in this community to conduct themselves professionally. Since our primary mode of communication is text on an online forum (e.g. issues, pull requests, comments, emails, or chats) devoid of vocal tone, gestures, or other context that is often vital to understanding, it is important that participants are attentive to their interaction style.
+
+* **Assume positive intent.** We ask community members to assume positive intent on the part of other people’s communications. We may disagree on details, but we expect all suggestions to be supportive of the community goals.
+* **Respect participants.** We expect occasional disagreements. Open Source projects are learning experiences. Ask, explore, challenge, and then _respectfully_ state if you agree or disagree. If your idea is rejected, be more persuasive not bitter.
+* **Welcoming to new members.** New members bring new perspectives. Some ask questions that have been addressed before. _Kindly_ point to existing discussions. Everyone is new to every project once.
+* **Be kind to beginners.** Beginners use open source projects to get experience. They might not be talented coders yet, and projects should not accept poor quality code. But we were all beginners once, and we need to engage kindly.
+* **Consider your impact on others.** Your work will be used by others, and you depend on the work of others. We expect community members to be considerate and establish a balance their self-interest with communal interest.
+* **Use words carefully.** We may not understand intent when you say something ironic. Often, people will misinterpret sarcasm in online communications. We ask community members to communicate plainly.
+* **Leave with class.** When you wish to resign from participating in this project for any reason, you are free to fork the code and create a competitive project. Open Source explicitly allows this. Your exit should not be dramatic or bitter. 
+
+### Unacceptable Behaviors
+Participants remain in good standing when they do not engage in misconduct or harassment (some examples follow). We do not list all forms of harassment, nor imply some forms of harassment are not worthy of action. Any participant who *feels* harassed or *observes* harassment, should report the incident to the Response Team. 
+* **Don't be a bigot.** Calling out project members by their identity or background in a negative or insulting manner. This includes, but is not limited to, slurs or insinuations related to protected or suspect classes e.g. race, color, citizenship, national origin, political belief, religion, sexual orientation, gender identity and expression, age, size, culture, ethnicity, genetic features, language, profession, national minority status, mental or physical ability.
+* **Don't insult.** Insulting remarks about a person’s lifestyle practices.
+* **Don't dox.** Revealing private information about other participants without explicit permission.
+* **Don't intimidate.** Threats of violence or intimidation of any project member.
+* **Don't creep.** Unwanted sexual attention or content unsuited for the subject of this project.
+* **Don't inflame.** We ask that victim of harassment not address their grievances in the public forum, as this often intensifies the problem. Report it, and let us address it off-line.
+* **Don't disrupt.** Sustained disruptions in a discussion.
+
+### Reporting Issues
+If you experience or witness misconduct, or have any other concerns about the conduct of members of this project, please report it by contacting our Response Team at opensource-conduct@verizonmedia.com who will handle your report with discretion. Your report should include:
+* Your preferred contact information. We cannot process anonymous reports.
+* Names (real or usernames) of those involved in the incident.
+* Your account of what occurred, and if the incident is ongoing. Please provide links to or transcripts of the publicly available records (e.g. a mailing list archive or a public IRC logger), so that we can review it.
+* Any additional information that may be helpful to achieve resolution.
+
+After filing a report, a representative will contact you directly to review the incident and ask additional questions. If a member of the Verizon Media Response Team is named in an incident report, that member will be recused from handling your incident. If the complaint originates from a member of the Response Team, it will be addressed by a different member of the Response Team. We will consider reports to be confidential for the purpose of protecting victims of abuse. 
+
+### Scope
+Verizon Media will assign a Response Team member with admin rights on the project and legal rights on the project copyright. The Response Team is empowered to restrict some privileges to the project as needed. Since this project is governed by an open source license, any participant may fork the code under the terms of the project license. The Response Team’s goal is to preserve the project if possible, and will restrict or remove participation from those who disrupt the project. 
+
+This code does not replace the terms of service or acceptable use policies that are provided by the websites used to support this community. Nor does this code apply to communications or actions that take place outside of the context of this community. Many participants in this project are also subject to codes of conduct based on their employment. This code is a social-contract that informs participants of our social expectations. It is not a terms of service or legal contract.
+
+## License and Acknowledgment. 
+This text is shared under the [CC-BY-4.0 license](https://creativecommons.org/licenses/by/4.0/). This code is based on a study conducted by the [TODO Group](https://todogroup.org/) of many codes used in the open source community. If you have feedback about this code, contact our Response Team at the address listed above. 

Contributing.md

@@ -0,0 +1,26 @@
+# How to contribute
+First, thanks for taking the time to contribute to our project! There are many ways you can help out.
+
+### Questions
+
+If you have a question that needs an answer, [create an issue](https://help.github.com/articles/creating-an-issue/), and label it as a question.
+
+### Issues for bugs or feature requests
+
+If you encounter any bugs in the code, or want to request a new feature or enhancement, please [create an issue](https://help.github.com/articles/creating-an-issue/) to report it. Kindly add a label to indicate what type of issue it is.
+
+### Contribute Code
+We welcome your pull requests for bug fixes. To implement something new, please create an issue first so we can discuss it together.
+
+***Creating a Pull Request***
+Please follow [best practices](https://github.com/trein/dev-best-practices/wiki/Git-Commit-Best-Practices) for creating git commits.
+
+When your code is ready to be submitted, [submit a pull request](https://help.github.com/articles/creating-a-pull-request/) to begin the code review process.
+
+We only seek to accept code that you are authorized to contribute to the project. We have added a pull request template on our projects so that your contributions are made with the following confirmation: 
+
+> I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.
+
+## Code of Conduct
+
+We encourage inclusive and professional interactions on our project. We welcome everyone to open an issue, improve the documentation, report bug or ssubmit a pull request. By participating in this project, you agree to abide by the [Verizon Media Code of Conduct](Code-of-Conduct.md). If you feel there is a conduct issue related to this project, please raise it per the Code of Conduct process and we will address it.

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2020 Verizon Media
+
+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.