Skip to content

Commit

Permalink
Resolve #7
Browse files Browse the repository at this point in the history
  • Loading branch information
nutjob4life committed Jul 29, 2021
1 parent 7914eb7 commit b96a3ea
Show file tree
Hide file tree
Showing 28 changed files with 980 additions and 259 deletions.
48 changes: 37 additions & 11 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,20 +1,46 @@

# This is a comment.
# 📀 Code Owners
#
# Copyright © 2021, California Institute of Technology ("Caltech").
# U.S. Government sponsorship acknowledged.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# • Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# • Redistributions must reproduce the above copyright notice, this list of
# conditions and the following disclaimer in the documentation and/or other
# materials provided with the distribution.
# • Neither the name of Caltech nor its operating division, the Jet Propulsion
# Laboratory, nor the names of its contributors may be used to endorse or
# promote products derived from this software without specific prior written
# permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
#
# Each line is a file pattern followed by one or more owners.

#
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @global-owner1 and @global-owner2 will be requested for
# review when someone opens a pull request.

# ***************************************************************
#
# Go to https://github.com/orgs/pds-data-dictionaries/teams to
# find out more information about your applicable team

* @NASA-PDS/pds-software-committers
# Go to https://github.com/orgs/NASA-PDS/teams to find out about our teams

# **************************************************************
* @NASA-PDS/pds-software-committers

# For more information on populating this file, go to
# For more information on populating this file, check out
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ assignees: jordanpadams

## 📜 To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
1. Go to ''
2. Click on ''
3. Scroll down to ''
4. See error

## 🕵️ Expected behavior
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/i-t-bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ assignees: jordanpadams
<!-- Document related test cases below -->


## 🔁 : Related issues
## 🔁 Related issues
<!-- Reference related issues below, e.g.
* for issues in this repo: #1 (remove back ticks)
* for issues in other repos: NASA-PDS/my_repo#1, NASA-PDS/that_repo#2
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/vulnerability-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ assignees: jordanpadams

---

## Vulnerability
## 🚨 Vulnerability
_Describe the vulnerability_

## Software Version
## 📀 Software Version
_Version_
38 changes: 38 additions & 0 deletions .github/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# ☝️ Code of Conduct

This document describes the ethical standards behind which the people who develop this software operate.


## ✋ Pledge

With the goal of fostering an environment that's open, inclusive, and completely non-prejudicial, we as the developers, contributors, and maintainers of this software undertake to make participation in this project free of harassment for everyone regardless of age, disability, ethnicity, race, body, gender identity and expression, education, level of experience, nationality, physical appearance, sexual identity and orientation, belief system or religion.


## 📖 Standards of Behavior

Enumerating the standards to which we adhere and require of participants is difficult, and so we give the following examples of behavior that promote positivity and further the pledge:

- Using welcoming and inclusive language
- Respecting viewpoints, cultural reference bases, and personal experiences
- Accepting criticism gracefully when it's given constructively
- Concentrating on the diversity and health of the community first, the code second
- Practicing genuine empathy and thoughtfulness towards every member

Examples of unacceptable behavior include but are not limited to:

- Using sexualized language or imagery and unwelcome sexual attention or advances
- Criticizing for the purpose of "trolling", insulting, making derogatory comments, or attacking the personal or political beliefs of others
- Harassing in private or in public
- Revealing others' private information, such as physical addresses and locations, private email addresses, and so forth, without prior express permission
- Any other conduct that may be considered inappropriate in a professional setting


## ✊ Responsibilities

The project maintainers bear the responsibility for clarifying these standards and are expected to take fair and corrective action in response to instances of unacceptable behavior. The project maintainers have the right to remove, modify, or reject any contribution to the project whether in the form of comment, wiki change, pull request, code commit, discussion, and so forth, that are not in keeping with the spirit of values expected of the community. Repeat violators of the code of conduct may be muted, temporarily or permanently removed.


## 🗺 Scope

This code of conduct applies not only to the visible project spaces within which progress is made on this code but also to other public and private spaces that involve the developers, contributors, and maintainers of the project. This includes and is not limited to public social media posting, private direct messages, email, discussion areas, message boards, and so on. In these and other venues, the project continues to be represented and the code of conduct still applies.

20 changes: 20 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 👥 Contributing

When contributing to this repository, first off, a moment of gratitude: 🙏 Thanks for wanting to help out!

Whether submitting a bug report, making a pull request, asking for a new feature, or fixing some documentation, these are all _contributions_. Please review these guidelines in order to make your contribution shine!

- **Is it a security vulnerability?** If so, please check out our [security policy](../SECURITY.md).
- **Is it a bug?**
- Check the issue tracker to see if it's already been reported or if something similar's been reported.
- If you can't find it, submit a new issue using the "bug" issue type.
- **Is it a code patch?**
- Open a new GitHub "pull request" with your patch.
- Make sure you describe the problem you're addressing (include links to issues if you can) and the solution you're proposing.
- **Is it a cosemtic change, such as to code formatting, white space, etc.?** We generally don't use these kinds of contributions.
- Cosmetic changes create unnecessary work in reviewing them as well as noise in the commit history.
- They also make backporting bugs a lot more difficult.
- **Is it a request for a new behavior or new feature?** Submit an issue using the "new feature" issue type.
- **Is it a question about the code?** You can [send us email](mailto:Jordan.Padams@jpl.nasa.gov).

Once again, thank you! ❤️
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## Summary
## 📜 Summary
<!-- Provide brief summary of changes below if not sufficiently described by commit messages. -->


## Test Data and/or Report
## 🩺 Test Data and/or Report
<!--
One of the following should be included below:
* Reference to regression test included in code (preferred wherever reasonable)
* Attach test data + outputs of tests
-->


## Related Issues
## 🧩 Related Issues
<!--
Reference related issues below using `Fixes` or `Resolves` in order to automatically close the issue upon merge. For more information on autolinking to tickets see https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls.
Expand Down
68 changes: 68 additions & 0 deletions .github/workflows/stable-cicd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 🏃‍♀️ Continuous Integration and Delivery: Stable
# ===============================================
#
# Note: for this workflow to succeed, the following secrets must be installed
# in the repository:
#
# ``ADMIN_GITHUB_TOKEN``
# A personal access token of a user with collaborator or better access to
# the project repository. You can generate this by visiting GitHub →
# Settings → Developer settings → Personal access tokens → Generate new
# token. Give the token scopes on ``repo``, ``write:packages``,
# ``delete:packages``, ``workflow``, and ``read:gpg_key``.
# ``CODE_SIGNING_KEY``
# A *private* key with which we can sign artifacts.
# ``OSSRH_USERNAME``
# Username for the Central Repository.
# ``OSSRH_USERNAME``
# Password for the Central Repository.
#


---

name: 😌 Stable integration & delivery


# Driving Event
# -------------
#
# What event starts this workflow: a push of a release tag. Note: according to
# https://git.io/JJZQt we have been doing our tag matching wrong. It's not
# regexp, it's not glob…it's more like…glob++ 😮

on:
push:
branches:
- 'release/*'


# What to Do
# ----------
#
# Round up, yee-haw!

jobs:
stable-assembly:
name: 🐴 Stable Assembly
runs-on: ubuntu-latest
steps:
-
name: 💳 Checkout
uses: actions/checkout@v2
with:
lfs: true
token: ${{secrets.ADMIN_GITHUB_TOKEN}}
fetch-depth: 0
-
name: 🤠 Roundup
uses: NASA-PDS/roundup-action@main
with:
assembly: stable
env:
ossrh_username: ${{secrets.OSSRH_USERNAME}}
ossrh_password: ${{secrets.OSSRH_PASSWORD}}
CODE_SIGNING_KEY: ${{secrets.CODE_SIGNING_KEY}}
ADMIN_GITHUB_TOKEN: ${{secrets.ADMIN_GITHUB_TOKEN}}

...
1 change: 1 addition & 0 deletions .github/workflows/unstable-cicd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,6 @@ jobs:
CODE_SIGNING_KEY: ${{secrets.CODE_SIGNING_KEY}}
ADMIN_GITHUB_TOKEN: ${{secrets.ADMIN_GITHUB_TOKEN}}

...

# -*- mode: yaml; indent: 4; fill-column: 120; coding: utf-8 -*-
44 changes: 41 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,44 @@
# Copyright © 2021, California Institute of Technology ("Caltech").
# U.S. Government sponsorship acknowledged.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# • Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# • Redistributions must reproduce the above copyright notice, this list of
# conditions and the following disclaimer in the documentation and/or other
# materials provided with the distribution.
# • Neither the name of Caltech nor its operating division, the Jet Propulsion
# Laboratory, nor the names of its contributors may be used to endorse or
# promote products derived from this software without specific prior written
# permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# Items for Git to ignore

# Object files
*.o
*.pkl
*.pyc
*.py[cod]

# Libraries
# Static libraries
*.lib
*.a
*.so

# Eclipse files
.settings/
Expand All @@ -16,6 +49,9 @@
.idea/
*.iml

# Sublime Text files
*.sublime-workspace

# Shared objects (inc. Windows DLLs)
*.dll
*.so
Expand All @@ -35,9 +71,11 @@
*.swp
/bin/
.*.swp
*.sublime-*

# Java stuff
*.javac
.gwt/
target/

# macOS specific stuff
.DS_Store
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# Change Log
# Changelog

Use some automated software like [Github Changelog Generator](https://github.com/github-changelog-generator/github-changelog-generator) to update this CHANGELOG.
Loading

0 comments on commit b96a3ea

Please sign in to comment.