Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GH action + workflow for setting up Go env in CI #43

Merged
merged 3 commits into from
Jul 17, 2024

Conversation

aulorbe
Copy link
Contributor

@aulorbe aulorbe commented Jul 17, 2024

Problem

CI currently won't run for generating godoc documentation because we have no "setup" steps that installs go and our project's dependencies.

Solution

Add 'em.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

Test Plan

CI passes.

@aulorbe aulorbe requested a review from austin-denoble July 17, 2024 00:17
Copy link
Contributor

@ssmith-pc ssmith-pc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@@ -0,0 +1,23 @@
name: 'Setup Go'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice thinking putting this into an action. 👍

@aulorbe aulorbe merged commit e9d98e1 into main Jul 17, 2024
3 checks passed
@aulorbe aulorbe deleted the Audrey/add-go-setup branch July 17, 2024 16:32
aulorbe added a commit that referenced this pull request Jul 17, 2024
## Problem

We tried a variety of different solutions for pushing static
documentation to our GH pages site (see `sdk-docs` repo for more
information), but the rendering was very bad.

Related PRs: 
- #41
- #42
- #43
- #44
- #45
- #46

## Solution

- Simply use the default hosting site of pkg.go.dev, and include
instructions for visiting the documentation on `main` vs the latest
release-version's documentation.
- Changed the documentation badge to point to latest documentation on
`main` instead of latest versioned-release's documentation.
- Remove GH workflow and action files

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [ ] Non-code change (docs, etc)
- [ ] None of the above: (explain here)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants