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

misc updates to readme, added PR template, added small ci/cd doc #1245

Merged
merged 5 commits into from Jan 5, 2021

Conversation

alex-frankel
Copy link
Collaborator

No description provided.

@codecov-io
Copy link

codecov-io commented Dec 31, 2020

Codecov Report

Merging #1245 (745ccdc) into main (7b1da15) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1245   +/-   ##
=======================================
  Coverage   94.48%   94.48%           
=======================================
  Files         338      338           
  Lines       16987    16987           
  Branches       14       14           
=======================================
  Hits        16050    16050           
  Misses        937      937           
Flag Coverage Δ
dotnet 95.02% <ø> (ø)
typescript 27.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Comment on lines +15 to +37
```yaml

name: bicep build and deploy

on: push

jobs:
bicep-build-and-deploy:
name: bicep build and deploy
runs-on: ubuntu-latest

steps:
# Checks out a copy of your repository on the ubuntu-latest machine
- name: Checkout code
uses: actions/checkout@v2

# Install the latest release of the bicep CLI
- name: Install bicep CLI
run: |
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64
chmod +x ./bicep
sudo mv ./bicep /usr/local/bin/bicep
bicep --help
Copy link
Member

Choose a reason for hiding this comment

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

Nice! Do you think it's also worth showing an example of CI (vs CD) - just the build step?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

meaning have a separate example that just goes to line 42?

Copy link
Member

Choose a reason for hiding this comment

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

Exactly. Feels trivially similar, but also serves a different purpose. I'm in two minds about whether it's worthwhile to include.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added a comment to point out where "CI" transitions into "CD", but for now I feel like it's overkill to go with a separate file

Copy link
Member

@anthony-c-martin anthony-c-martin left a comment

Choose a reason for hiding this comment

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

Nice!

@@ -0,0 +1,20 @@
# Contributing a Pull Request

If you haven't already, read the full [contribution guide](../CONTRIBUTING.md). Once you are done and ready to submit your PR, run through the relevant checklist below.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you add something like this? "The contribution guide may have changed since the last time you read it."

Copy link
Collaborator

@majastrz majastrz left a comment

Choose a reason for hiding this comment

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

Added a comment.

@alex-frankel alex-frankel merged commit 4f4639f into main Jan 5, 2021
@alex-frankel alex-frankel deleted the alfran/miscDocUpdates branch January 5, 2021 20:27
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.

None yet

4 participants