Skip to content

Commit

Permalink
Make release workflow upload both Docker Hub and GitHub Release READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
tuxji committed Dec 17, 2020
1 parent e0f1b01 commit e5e8a35
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 4 deletions.
11 changes: 10 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,15 @@ jobs:
if: matrix.builder == 'docker'
run: docker push gehighassurance/rack-box:${{ github.event.release.tag_name }}

- name: Update Docker Hub Description
if: matrix.builder == 'docker'
uses: peter-evans/dockerhub-description@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_PASSWORD }}
repository: gehighassurance/rack-box
readme-filepath: RACK/rack-box/Docker-Hub-README.md

- name: Split rack-box image
if: matrix.builder != 'docker'
run: |
Expand Down Expand Up @@ -223,6 +232,6 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: RACK/rack-box/README-GitHub-Release.md
asset_path: RACK/rack-box/GitHub-Release-README.md
asset_name: README.md
asset_content_type: text/markdown; charset=UTF-8
File renamed without changes.
46 changes: 46 additions & 0 deletions rack-box/GitHub-Release-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## Run the Docker RACK box

Here are very brief instructions how to run the Docker RACK box. You will find more detailed [instructions](https://github.com/ge-high-assurance/RACK/wiki/Install-a-Docker-RACK-Box) in the RACK Wiki. You will need to give your Docker Hub username to the RACK team so you can be given access to our Docker Hub repository.

1. Open a terminal window where you can run `docker`.
2. Type `docker pull gehighassurance/rack-box:v4.1`
3. Type `docker run --detach -p 80:80 -p 12050-12092:12050-12092 gehighassurance/rack-box:v4.1`
4. Visit <http://localhost/> in your browser to view the RACK box's welcome page.

## Run the Virtual RACK box

Here are very brief instructions how to run the Virtual RACK box. You will find more detailed [instructions](https://github.com/ge-high-assurance/RACK/wiki/Install-a-Virtual-RACK-Box) in the RACK Wiki.

1. Download the split VirtualBox zip files.
2. Concatenate the split VirtualBox zip files together.
3. Unzip the newly concatenated zip file.
4. Start VirtualBox.
5. Import the VirtualBox VM from the rack-box-virtualbox-v4.1 folder.
6. Open the VM's Settings.
7. Click on Network.
8. Change the first network adapter from NAT to Bridged.
9. Bind one of your existing network adapters to the bridged network adapter.
10. Start the VM.

## View the RACK box's welcome page

You will need to know which IP address the VM is using after it starts up. If you can't find the IP address any other way, you can use the VM window to log into the VM and print its IP address:

1. Click in the VM's window.
2. Type "ubuntu" at the username prompt.
3. Type "ubuntu" at the password prompt.
4. Type "ip a" at the shell prompt.
5. Look for the IP address in the second adapter.

Type that IP address in your web browser's address bar, hit Enter, and you should see the RACK box's welcome page appear in your browser.

---
Copyright (c) 2020, General Electric Company, Galois, Inc.

All Rights Reserved

This material is based upon work supported by the Defense Advanced Research Projects Agency (DARPA) under Contract No. FA8750-20-C-0203.

Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the Defense Advanced Research Projects Agency (DARPA).

Distribution Statement "A" (Approved for Public Release, Distribution Unlimited)
7 changes: 4 additions & 3 deletions rack-box/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,13 +129,14 @@ To make a new release, we will need to perform the following steps:

## Update documentation pages

Before making a new release, we will need to update instructions or
version numbers in the following places:
Before making a new release, we will need to update version numbers or
instructions in the following places:

### RACK Box

- [ ] [Docker-Hub-README.md](Docker-Hub-README.md)
- [ ] [GitHub-Release-README.md](GitHub-Release-README.md)
- [ ] [README.md](README.md)
- [ ] [README-Docker-Hub.md](README-Docker-Hub.md)

### RACK Wiki

Expand Down

0 comments on commit e5e8a35

Please sign in to comment.