Skip to content

Commit

Permalink
Merge pull request #27 from usnistgov/rename_primary_branch
Browse files Browse the repository at this point in the history
Rename primary branch
  • Loading branch information
ajnelson-nist authored Mar 19, 2024
2 parents dd9578f + a4a2142 commit 8559c76
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The project team regularly reviews the open issues, prioritizes their handling,
This project uses a typical GitHub fork and pull request [workflow](https://guides.github.com/introduction/flow/). To establish a development environment for contributing to the project, you must do the following:

1. Fork the repository to your personal workspace. Please refer to the Github [guide on forking a repository](https://help.github.com/articles/fork-a-repo/) for more details.
1. Create a feature branch from the master branch for making changes. You can [create a branch in your personal repository](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) directly on GitHub or create the branch using a Git client. For example, the ```git branch working``` command can be used to create a branch named *working*.
1. Create a feature branch from the `develop` branch for making changes. You can [create a branch in your personal repository](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) directly on GitHub or create the branch using a Git client. For example, the ```git branch working``` command can be used to create a branch named *working*.
1. You will need to make your modifications by adding, removing, and changing the content in the branch, then staging your changes using the ```git add``` and ```git rm``` commands.
1. Once you have staged your changes, you will need to commit them. When committing, you will need to include a commit message. The commit message should describe the nature of your changes (e.g., added new feature X which supports Y). You can also reference an issue from the project repository by using the hash symbol. For example, to reference issue #34, you would include the text "#34". The full command would be: ```git commit -m "added new feature X which supports Y addressing issue #34"```.
1. Next, you must push your changes to your personal repo. You can do this with the command: ```git push```.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Software Identification (SWID) Tagging Tools and Utilities
[![CircleCI](https://circleci.com/gh/usnistgov/swid-tools/tree/master.svg?style=svg)](https://circleci.com/gh/usnistgov/swid-tools/tree/master) [![Gitter](https://img.shields.io/gitter/room/swid-tools/community.svg?style=flat-square)](https://gitter.im/swid-tools/community)
[![CircleCI](https://circleci.com/gh/usnistgov/swid-tools/tree/main.svg?style=svg)](https://circleci.com/gh/usnistgov/swid-tools/tree/main) [![Gitter](https://img.shields.io/gitter/room/swid-tools/community.svg?style=flat-square)](https://gitter.im/swid-tools/community)

This project provides a set of Java-based tools for the generation and validation of Software Identification (SWID) tags produced by the NIST [SWID Tagging Project](https://csrc.nist.gov/projects/Software-Identification-SWID). These tools support XML-based SWID tags based on the format defined by ISO/IEC 19770-2:2015, and [Concise Binary Object Representation](https://cbor.io/) (CBOR) based concise SWID (CoSWID) tags based on the [IETF CoSWID](https://datatracker.ietf.org/doc/draft-ietf-sacm-coswid/) specification.

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<properties>
<!-- shared site configuration -->
<site.url>https://pages.nist.gov/swid-tools</site.url>
<scm.url>https://github.com/usnistgov/swid-tools/tree/master</scm.url>
<scm.url>https://github.com/usnistgov/swid-tools/tree/main</scm.url>
<issueManagement.url>https://github.com/usnistgov/swid-tools/issues</issueManagement.url>

<!-- dependencies -->
Expand Down
2 changes: 1 addition & 1 deletion swid-builder/src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ The following dependency can be added to your POM to use this library.
The [API documentation](apidocs/index.html) provides more details.


The [source](https://github.com/usnistgov/swid-tools/tree/master/swid-builder/) can be found in the project's Github repo.
The [source](https://github.com/usnistgov/swid-tools/tree/main/swid-builder/) can be found in the project's Github repo.
4 changes: 2 additions & 2 deletions swid-maven-plugin/src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Two generation capabilities are provided:
- **Assembly SWID Generator:** A [container descriptor handler](http://maven.apache.org/plugins/maven-assembly-plugin/examples/single/using-container-descriptor-handlers.html) that supports generation of a SWID tag as a manifest of a Maven [Assembly](http://maven.apache.org/plugins/maven-assembly-plugin/). Maven assemblies are binary distributions of Java code archived using a number of popular archive formats.
- **SWD Generation Mojo:** An experimental Maven mojo for building a SWID tag for use within a Java JAR file.

The [source](https://github.com/usnistgov/swid-tools/tree/master/swid-maven-plugin/) for these capabilities can be found in the project's Github repo.
The [source](https://github.com/usnistgov/swid-tools/tree/main/swid-maven-plugin/) for these capabilities can be found in the project's Github repo.

$h2 The Assembly SWID Generator

To generate a SWID tag as part of the execution of the Maven [Assembly](http://maven.apache.org/plugins/maven-assembly-plugin/) plugin, a couple configurations need to be made.

The following example is the configuration used by the [swidval project](https://github.com/usnistgov/swid-tools/tree/master/swidval).
The following example is the configuration used by the [swidval project](https://github.com/usnistgov/swid-tools/tree/main/swidval).

First, the assembly descriptor needs to be configured to use the `swid-generator`. In the following example, the assembly descriptor located in `src/assembly/bin.xml` has the needed `<containerDescriptorHandler>` configured as follows:

Expand Down
2 changes: 1 addition & 1 deletion swid-repo-client/src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The following dependency can be added to your POM to use this library.

The [API documentation](apidocs/index.html) provides more details.

The [source](https://github.com/usnistgov/swid-tools/tree/master/swid-repo-client) can be found in the project's Github repo.
The [source](https://github.com/usnistgov/swid-tools/tree/main/swid-repo-client) can be found in the project's Github repo.
2 changes: 1 addition & 1 deletion swidval-webapp/src/site/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ A simple, proof of concept webapp that provides a SWID validation service that i

This web application is a wrapper around the [SWIDVal](../swidval) tool, which can be deployed as a WAR file to a Java application server.

The [source](https://github.com/usnistgov/swid-tools/tree/master/swidval-webapp) can be found in the project's Github repo.
The [source](https://github.com/usnistgov/swid-tools/tree/main/swidval-webapp) can be found in the project's Github repo.
2 changes: 1 addition & 1 deletion swidval/src/site/markdown/index.md.vm
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Supports validating a SWID tag against the requirements defined by ISO/IEC 19770

This project is implemented using the [Decima Framework][decima], which provides the validation capabilities used to perform the SWID tag validation.

The [source](https://github.com/usnistgov/swid-tools/tree/master/swidval) can be found in the project's Github repo.
The [source](https://github.com/usnistgov/swid-tools/tree/main/swidval) can be found in the project's Github repo.

$h2 Use as a Command Line Tool

Expand Down

0 comments on commit 8559c76

Please sign in to comment.