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

Adds jenv's .java-version to project .gitignore #317

Merged

Conversation

bengineerdavis
Copy link
Contributor

@bengineerdavis bengineerdavis commented Mar 27, 2024

What

  • Makes git ignore jenv's ..java-version file, to avoid adding it as an unintended artifact in future commits
  • As of now, we do not explicitly encourage saving this file, nor do we require jenv to contribute to the project, indicating that jenv is the responsibility of the user, instead of the maintainer(s)

How

  • Adds a rule to the project-level .gitignore file to ignore all .java-version files

Recommended reading order

  1. Related to the initial steps in developing-locally

Can this PR be safely reverted and rolled back?

  • [ x ] YES 💚
  • NO ❌

Problem

For parts of the repository that require jenv to control the Java
version, a corresponding .java-version file artifact is required to
co-exist in the target directory for the following command:

    `jenv local <version #>`

This file should only be explicitly added to the repository.

This relates to the initial steps defined in this document:
[developing-locally](https://docs.airbyte.com/contributing-to-airbyte/resources/developing-locally)

Solution

- Adds a rule to the project-level .gitignore file to ignore all
.java-version files

Note

No additional steps required.
@CLAassistant
Copy link

CLAassistant commented Mar 27, 2024

CLA assistant check
All committers have signed the CLA.

@bengineerdavis bengineerdavis self-assigned this Mar 27, 2024
@bengineerdavis bengineerdavis added bug Something isn't working enhancement New feature or request area/platform and removed bug Something isn't working labels Mar 27, 2024
@bengineerdavis bengineerdavis merged commit 7c54196 into main Apr 1, 2024
@bengineerdavis bengineerdavis deleted the bengineer/add-java-version-jenv-file-to-gitignore branch April 1, 2024 21:48
nathanseal pushed a commit to upollo/airbyte-platform that referenced this pull request Apr 16, 2024
## What

* Makes git ignore [`jenv`](https://www.jenv.be/)'s .`.java-version`
file, to avoid adding it as an unintended artifact in future commits
* As of now, we do not explicitly encourage saving this file, nor do we
require [`jenv`](https://www.jenv.be/) to contribute to the project,
indicating that [`jenv`](https://www.jenv.be/) is the responsibility of
the user, instead of the maintainer(s)

## How

* Adds a rule to the project-level .gitignore file to ignore all
.java-version files

## Recommended reading order
1. Related to the initial steps in
[developing-locally](https://docs.airbyte.com/contributing-to-airbyte/resources/developing-locally)

## Can this PR be safely reverted and rolled back?
<!--
* If you know that your be safely rolled back, check YES.*
* If that is not the case (e.g. a database migration), check NO.
* If unsure, leave it blank.*
-->
- [ x ] YES 💚
- [ ] NO ❌
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants