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

Rewritten tutorial to write a very simple AWS Lambda #131

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

regularfry
Copy link
Contributor

Description

The prior tutorial branch involved Docker usage that we don't want to involve as a first contact with the framework. This (minor) rewrite skips the Docker setup, instead leaning on asdf for python version management, and a python example that doesn't have any runtime pip dependencies.

I have also included a tweak to the markdownlint.yaml config file so that Makefile quotes and console output are allowed to have tab characters in them.

Context

Time to first execution is lower.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@regularfry
Copy link
Contributor Author

There's an important outstanding question here, and that's this. What do we want to do about SonarCloud, for someone random trying this out? I'm quite keen that this should work out of the box.

@stefaniuk
Copy link
Contributor

There's an important outstanding question here, and that's this. What do we want to do about SonarCloud, for someone random trying this out? I'm quite keen that this should work out of the box.

Thanks @regularfry, as discussed, we'll update the SonarCloud onboarding instructions to reflect the current process. Also, please note that the GitHub action that triggers the analysis will not execute if the secrets/variables are not set up. Therefore, the workflow should proceed to the next step not affecting the dev experience.

I may make some suggestions on the wording once we have full clarity on the Sonar onboarding process, as this is still WIP.

docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
github-merge-queue bot pushed a commit that referenced this pull request Nov 21, 2023
<!-- markdownlint-disable-next-line first-line-heading -->
## Description

This adds the `make _install-dependencies` task, which installs
everything from the `.tool-versions` file.

## Context

This avoids the need to add a new `make` task for each dependency,
instead treating the `.tool-versions` file as canonical. Specifically it
avoids the need for the user to add a `make _install-python` task in
[the
tutorial](#131).

For discussion: do we still need `make _install-terraform` if we have
this? I don't think we do.

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [ ] Refactoring (non-breaking change)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [ ] I am familiar with the [contributing
guidelines](../docs/CONTRIBUTING.md)
- [ ] I have followed the code style of the project
- [ ] I have added tests to cover my changes
- [ ] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

## Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [ ] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.
regularfry and others added 5 commits November 25, 2023 08:02
The prior tutorial branch involved Docker usage that we don't want to involve
as a first contact with the framework.  This (minor) rewrite skips the Docker
setup, instead leaning on `asdf` for python version management.
The TODO was unnecessary: the SonarCloud step in the build pipeline fails open
if it's not configured.
@regularfry regularfry requested a review from stefaniuk May 22, 2024 10:02
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.

2 participants