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 file exist checking to repo client #105

Open
3 of 5 tasks
CalvinWilkinson opened this issue Nov 15, 2024 · 0 comments
Open
3 of 5 tasks

🚧Add file exist checking to repo client #105

CalvinWilkinson opened this issue Nov 15, 2024 · 0 comments
Assignees
Labels
💎enhancement An improvement on something high-priority High Priority preview Done while in preview

Comments

@CalvinWilkinson
Copy link
Member

CalvinWilkinson commented Nov 15, 2024

Complete The Item Below

  • I have updated the title without removing the 🚧 emoji.

Description

Add the ability to check if a repository file exists before getting or updating the file in the RepoClient. This check can then be used to throw a proper error that the file does not exist before getting the file or updating the file.

Currently, when using the getFileContent() or updateFile() functions, if the file does not exist, then an error is thrown but with no information as to why. Performing a file check first will give the ability to throw an error correctly to notify the user why the fail occurred.

Use the existing fileExists() function to check for the file first.

Acceptance Criteria

The items to complete to satisfy the Definition of Done.

Preview Give feedback

ToDo Items

The items to complete to satisfy the Definition of Done.

Preview Give feedback

Issue Dependencies

No response

Related Work

No response

Additional Information:

Unit Tests

Reasons for local unit test execution:

  • Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
  • Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.
  • If you notice that the test status check has passed but the test failed locally, please notify a project maintainer!

💡Warning💡
If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production.
Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.

Change Type Labels

Change Type Label
Bug Fixes 🐛bug
Breaking Changes 🧨breaking-changes
New Feature ✨new-feature
CICD Changes ♻️cicd
Config Changes ⚙️config
Performance Improvements 🏎️performance
Code Doc Changes 🗒️documentation/code
Product Doc Changes 📝documentation/product

Priority Type Labels

Priority Type Label
Low Priority low priority
Medium Priority medium priority
High Priority high priority

Code of Conduct

  • I agree to follow this project's Code of Conduct.
@CalvinWilkinson CalvinWilkinson added high-priority High Priority preview Done while in preview 💎enhancement An improvement on something labels Nov 15, 2024
@CalvinWilkinson CalvinWilkinson added this to the v1.0.0-preview.15 milestone Nov 15, 2024
@CalvinWilkinson CalvinWilkinson self-assigned this Nov 15, 2024
@github-project-automation github-project-automation bot moved this to ⚪Not Set in KD-Team Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💎enhancement An improvement on something high-priority High Priority preview Done while in preview
Projects
Status: ⚪Not Set
Development

No branches or pull requests

1 participant