Skip to content

Commit

Permalink
Removed Changelog from the landing page and have the app version on t…
Browse files Browse the repository at this point in the history
…he top menu as a link directing to the changelog page(#606)

* Made changelog div container scrollable to avoid page elongation

Signed-off-by: Vanessa Fotso <[email protected]>

* update draft release schedule

Signed-off-by: Vanessa Fotso <[email protected]>

* update vulcan setup to also load the sample data

Signed-off-by: Vanessa Fotso <[email protected]>

* Updated features, added release info and test user to the readme

Signed-off-by: Vanessa Fotso <[email protected]>

* Removed changelog from landing page and cleanup unused methods & dependency

Signed-off-by: Vanessa Fotso <[email protected]>

* Updated setup and readme

Signed-off-by: Vanessa Fotso <[email protected]>

---------

Signed-off-by: Vanessa Fotso <[email protected]>
  • Loading branch information
vanessuniq authored Oct 2, 2023
1 parent b823436 commit bfd5916
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/create-draft-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Create Release Draft

on:
schedule:
- cron: "0 0 */14 * *" # Every 14 days at midnight (format: "`min(0 - 59)` `hr(0 - 23)` `day of month(1 - 31)` `month(1 - 12) ` `day of week(0 - 6)`")
- cron: "0 17 */14 * *" # Every 14 days at 17:00 (format: "`min(0 - 59)` `hr(0 - 23)` `day of month(1 - 31)` `month(1 - 12) ` `day of week(0 - 6)`")

jobs:
create_release_draft:
Expand Down
3 changes: 0 additions & 3 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,6 @@ gem 'rubyzip'
gem 'mitre-inspec-objects'
gem 'rest-client'

# Markdown processing
gem 'redcarpet'

group :development do
gem 'listen', '~> 3.1.5'
# Access an interactive console on exception pages or by calling 'console' anywhere in the code.
Expand Down
2 changes: 0 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,6 @@ GEM
rb-fsevent (0.11.1)
rb-inotify (0.10.1)
ffi (~> 1.0)
redcarpet (3.6.0)
regexp_parser (2.2.1)
request_store (1.5.1)
rack (>= 1.4)
Expand Down Expand Up @@ -565,7 +564,6 @@ DEPENDENCIES
pg (>= 0.18, < 2.0)
puma (~> 5.6)
rails (~> 6.1.4)
redcarpet
rest-client
rspec-mocks
rspec-rails (~> 4.0.0)
Expand Down
53 changes: 41 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,50 @@ Vulcan models the STIG intent form and the process of aligning security controls
* Model the STIG creation process between the creator (vendor) and the approver (sponsor)
* Write and test InSpec code on a local system, or across SSH, AWS, and Docker targets
* Easily view control status and revision history
* Enable distributed authorship with multiple authors working on sets of controls and reviewing each others' work
* Enable distributed authorship with multiple authors working on sets of controls and reviewing each others' work.
* Enable looking up related controls (controls using the same SRG ID) in published STIGs while auhtoring or reviewing a control.
* View DISA published STIG Contents.
* Confidential data in the database is encrypted using symmetric encryption
* Authenticate via the local server, through GitHub, and through configuring an LDAP server.
* Email and Slack notification enabled

## Latest Release: [v2.1.4](https://github.com/mitre/vulcan/releases/tag/v2.1.4)

You can pull the Docker image for the latest release with the following command:

```bash
docker pull mitre/vulcan:v2.1.4
```

For more details on this release and previous ones, check the [Changelog](https://vulcan.mitre.org/CHANGELOG.html).

## Deploy Vulcan

[Deploying Vulcan in Production](https://vulcan.mitre.org/docs/)&nbsp;&nbsp;&nbsp;[<img src="public/GitHub-Mark-Light-64px.png#gh-dark-mode-only" width="20"/>](https://pages.github.com/)[<img src="public/GitHub-Mark-64px.png#gh-light-mode-only" width="20"/>](https://pages.github.com/)

## Deployment Dependencies:
## Deployment Dependencies

For Ruby (on Ubuntu):
* Ruby
* `build-essentials`
* Bundler
* `libq-dev`
* nodejs

* Ruby
* `build-essentials`
* Bundler
* `libq-dev`
* nodejs

### Run With Ruby

#### Setup Ruby

1. Install the version of Ruby specified in `.ruby-version`
2. Install postgres and rbenv
3. gem install foreman
4. rbenv install
5. bin/setup
3. Run `gem install foreman`
4. Run `rbenv install`
5. Run `bin/setup`

>> **Note**: `bin/setup` will install the JS dependencies andprepare the database.
6. Run `rails db:seed` to seed the database.

#### Running with Ruby

Expand All @@ -44,12 +64,19 @@ Make sure you have run the setup steps at least once before following these step
2. foreman start -f Procfile.dev
3. Navigate to `http://127.0.0.1:3000`

#### Test User

For testing purposes in the development environment, you can use the following credentials:

**Email**: <[email protected]>

**Password**: 1234567ab!

#### Stopping Vulcan

1. Stop Vulcan by doing `ctrl + c`
2. Stop the postgres server


## Configuration

See `docker-compose.yml` for container configuration options.
Expand Down Expand Up @@ -87,6 +114,9 @@ and the impact on the application's performance when deciding on the frequency.

>> Please refer to your hosting platform's documentation or support services for specific instructions on how to set up scheduled tasks or cron jobs.
## Releasing Vulcan

For detailed information about creating a release, please refer to the [release documentation](https://github.com/mitre/vulcan/wiki/Release_vulcan).

### NOTICE

Expand All @@ -105,4 +135,3 @@ This software was produced for the U. S. Government under Contract Number HHSM-5
No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation.

For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.

35 changes: 0 additions & 35 deletions app/helpers/application_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -21,39 +21,4 @@ def base_navigation

nav_links
end

# Get the latest release changes to display on the landing page
def latest_release_details
changelog_path = Rails.root.join('CHANGELOG.md')
release_details = ''

begin
File.open(changelog_path, 'r') do |file|
line = file.gets
while line
if line.start_with?('## [v')
# Found the beginning of a release, start reading details
release_details = line
line = file.gets
while line && !line.start_with?('## [v')
release_details += line
line = file.gets
end
# Exit the loop once the latest release details have been read
break
end
line = file.gets
end
end
rescue StandardError => e
Rails.logger.error "Unable to read latest release: #{e.message}"
end

release_details
end

def markdown_to_html(text)
options = %i[hard_wrap autolink no_intra_emphasis fenced_code_blocks]
Markdown.new(text, *options).to_html
end
end
5 changes: 4 additions & 1 deletion app/javascript/components/navbar/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
<b-navbar toggleable="lg" type="dark" variant="dark">
<b-navbar-brand id="heading" href="/">
<i class="mdi mdi-radar" aria-hidden="true" />
VULCAN <span class="latest-release">{{ currentVersion }}</span>
VULCAN
<b-link href="https://vulcan.mitre.org/CHANGELOG.html" target="_blank">
<span class="latest-release">{{ currentVersion }}</span>
</b-link>
</b-navbar-brand>
<b-navbar-toggle target="nav-collapse" />

Expand Down
1 change: 0 additions & 1 deletion app/views/devise/shared/_what_is_vulcan.html.haml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@

%p Vulcan helps Subject Matter Experts (SMEs) apply Security Requirements Guides (SRGs) to author Security Technical Implementation Guides (STIGs) & corresponding InSpec Profiles as security testing content.
%p=Settings['welcome_text']
%div.mt-4=markdown_to_html(latest_release_details).html_safe

0 comments on commit bfd5916

Please sign in to comment.