Skip to content

Commit

Permalink
Update usename HTsuruo to htsuruo
Browse files Browse the repository at this point in the history
  • Loading branch information
htsuruo committed Sep 3, 2023
1 parent 6610251 commit cc9482b
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Back up Firestore to Storage issue
about: A issue for Back up Firestore to Storage extensions
title: "[back-up-firestore-to-storage] Here is issue title"
labels: ''
assignees: HTsuruo
assignees: htsuruo

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Trigger GitHub issues from Crashlytics issue
about: A issue for Trigger GitHub issues from Crashlytics extension
title: "[trigger-github-issues-from-crashlytics] Here is issue title"
labels: ''
assignees: HTsuruo
assignees: htsuruo

---

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# firebase-extensions

This is a collection of Firebase Extensions build by [HTsuruo](https://github.com/HTsuruo), designed to help you build better apps faster.
This is a collection of Firebase Extensions build by [htsuruo](https://github.com/htsuruo), designed to help you build better apps faster.

## List of Extensions

- [back-up-firestore-to-storage](https://github.com/HTsuruo/firebase-extensions/tree/main/back-up-firestore-to-storage)
- [back-up-firestore-to-storage](https://github.com/htsuruo/firebase-extensions/tree/main/back-up-firestore-to-storage)
- Exports Firestore documents to Cloud Storage at any scheduled time.
- [Install in Firebase Console](https://extensions.dev/extensions/htsuruo/back-up-firestore-to-storage)
- [trigger-github-issues-from-crashlytics](https://github.com/HTsuruo/firebase-extensions/tree/main/trigger-github-issues-from-crashlytics)
- [trigger-github-issues-from-crashlytics](https://github.com/htsuruo/firebase-extensions/tree/main/trigger-github-issues-from-crashlytics)
- Automatically creates GitHub Issues triggered by Crashlytics alerts.
- [Install in Firebase Console](https://extensions.dev/extensions/htsuruo/trigger-github-issues-from-crashlytics)

Expand Down
36 changes: 25 additions & 11 deletions back-up-firestore-to-storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

**Description**: Exports Firestore documents to Cloud Storage at any scheduled time.



**Details**: By using this extension, export selected Firestore documents to Cloud Storage at any scheduled time. It depends on Google API's [exportDocuments](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases/exportDocuments).

This extension streamlines the creation of content outlined in the Schedule data exports section of [the official Firebase documentation](https://firebase.google.com/docs/firestore/solutions/schedule-export).It eliminates the need to manually create service accounts or configure Cloud Functions. Just install the extension, and with a single click, you're all set up.
Expand Down Expand Up @@ -35,36 +37,48 @@ This extension uses other Firebase or Google Cloud Platform services which may h

When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing)




**Configuration Parameters:**

- Cloud Storage bucket: If not set, `[project-id].appspot.com` is set as the default. If set, the bucket must exist before using this extension. Be sure to consider Google Cloud Storage naming guidelines: [Bucket names](https://cloud.google.com/storage/docs/buckets#naming)
* Cloud Storage bucket: If not set, `[project-id].appspot.com` is set as the default. If set, the bucket must exist before using this extension. Be sure to consider Google Cloud Storage naming guidelines: [Bucket names](https://cloud.google.com/storage/docs/buckets#naming)

- Cloud Storage prefix path (not including heading slash, filename): This is an optional Google Cloud Storage namespace path.
* Cloud Storage prefix path (not including heading slash, filename): This is an optional Google Cloud Storage namespace path.

- Firestore collection ids (separated by ','): Which collection ids to export. Unspecified means all collections.
* Firestore collection ids (separated by ','): Which collection ids to export. Unspecified means all collections.

- The frequency at which you want to execute the backup: - This field can accept strings that use either syntax:
* The frequency at which you want to execute the backup: - This field can accept strings that use either syntax:
- unix-cron syntax (for example, `5 11 * * *`)
- App Engine syntax (for example, `every 5 minutes`)

- The timestamp format for path name to export: If not set, **YYYY-MM-DDTHH\:mm:ss_SSS** is set as the default. This is same to the default folder name of `exportDocuments` API.
* The timestamp format for path name to export: If not set, **YYYY-MM-DDTHH\:mm:ss_SSS** is set as the default. This is same to the default folder name of `exportDocuments` API.


* The time zone in which the schedule will run: Refer to [this document](https://cloud.google.com/looker/docs/reference/param-view-timezone-values).

* Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

- The time zone in which the schedule will run: Refer to [this document](https://cloud.google.com/looker/docs/reference/param-view-timezone-values).

- Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

**Cloud Functions:**

- **backupTransaction:** Schedule triggered function that executes backup Firestore to Cloud Storage
* **backupTransaction:** Schedule triggered function that executes backup Firestore to Cloud Storage



**APIs Used**:

- firestore.googleapis.com (Reason: Exports Firestore documents in a restorable format)
* firestore.googleapis.com (Reason: Exports Firestore documents in a restorable format)



**Access Required**:



This extension will operate with the following project IAM roles:

- datastore.importExportAdmin (Reason: Allows the extension to export Firestore documents data.)
* datastore.importExportAdmin (Reason: Allows the extension to export Firestore documents data.)

- storage.objectAdmin (Reason: Allows the extension to upload exported Firestore documents data to Cloud Storage.)
* storage.objectAdmin (Reason: Allows the extension to upload exported Firestore documents data to Cloud Storage.)
2 changes: 1 addition & 1 deletion back-up-firestore-to-storage/extension.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ params:
- param: TIMESTAMP_FORMAT
label: The timestamp format for path name to export
# デフォルトフォーマットの記述箇所はコードブロックではエスケープが想定通りに機能しないのでBoldにしています。
# ref. https://github.com/HTsuruo/firebase-extensions/pull/9#issuecomment-1597340454
# ref. https://github.com/htsuruo/firebase-extensions/pull/9#issuecomment-1597340454
description: >
If not set, **YYYY-MM-DDTHH\:mm:ss_SSS** is set as the default. This is same to the default folder name of `exportDocuments` API.
type: string
Expand Down
6 changes: 3 additions & 3 deletions trigger-github-issues-from-crashlytics/PREINSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The features of this extension are as follows:

| Crashlytics Issue | GitHub Issue |
|--------|--------|
| <img width="900" alt="SCR-20230529-ukgw-2" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/d019c106-a2c2-4b76-b5f9-2327609fe3a0"> | <img width="970" alt="SCR-20230529-ukml" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/8eafcf03-a285-4067-b56f-36e378747758"> |
| <img width="900" alt="SCR-20230529-ukgw-2" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/d019c106-a2c2-4b76-b5f9-2327609fe3a0"> | <img width="970" alt="SCR-20230529-ukml" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/8eafcf03-a285-4067-b56f-36e378747758"> |

## Supported crashlytics alerts

Expand All @@ -25,7 +25,7 @@ The features of this extension are as follows:

## Additional setup

Before installing this extension, make sure that you've [created a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in your GitHub account to access the GitHub API(if your repository is organization, use GitHub Apps).
Before installing this extension, make sure that you've [created a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in your GitHub account to access the GitHub API(if your repository is organization, use GitHub Apps).

Two approaches exist for creating access tokens, but `Fine-grained personal access tokens` are recommended.

Expand All @@ -34,7 +34,7 @@ Two approaches exist for creating access tokens, but `Fine-grained personal acce
When creating a PAT (Personal Access Token), you need to give it the following permission:
`repository permissions > Issues > Read and write`

<img width="630" alt="SCR-20230527-ogal-2" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/719bcfd8-12c7-4336-adde-924738553592">
<img width="630" alt="SCR-20230527-ogal-2" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/719bcfd8-12c7-4336-adde-924738553592">

## Billing

Expand Down
8 changes: 4 additions & 4 deletions trigger-github-issues-from-crashlytics/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Trigger GitHub issues from Crashlytics

**Author**: Hideki TSURUOKA (**[https://github.com/HTsuruo](https://github.com/HTsuruo)**)
**Author**: Hideki TSURUOKA (**[https://github.com/htsuruo](https://github.com/htsuruo)**)

**Description**: Automatically creates GitHub Issues triggered by Crashlytics alerts.

Expand All @@ -17,7 +17,7 @@ The features of this extension are as follows:

| Crashlytics Issue | GitHub Issue |
|--------|--------|
| <img width="900" alt="SCR-20230529-ukgw-2" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/d019c106-a2c2-4b76-b5f9-2327609fe3a0"> | <img width="970" alt="SCR-20230529-ukml" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/8eafcf03-a285-4067-b56f-36e378747758"> |
| <img width="900" alt="SCR-20230529-ukgw-2" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/d019c106-a2c2-4b76-b5f9-2327609fe3a0"> | <img width="970" alt="SCR-20230529-ukml" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/8eafcf03-a285-4067-b56f-36e378747758"> |

## Supported crashlytics alerts

Expand All @@ -33,7 +33,7 @@ The features of this extension are as follows:

## Additional setup

Before installing this extension, make sure that you've [created a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in your GitHub account to access the GitHub API(if your repository is organization, use GitHub Apps).
Before installing this extension, make sure that you've [created a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) in your GitHub account to access the GitHub API(if your repository is organization, use GitHub Apps).

Two approaches exist for creating access tokens, but `Fine-grained personal access tokens` are recommended.

Expand All @@ -42,7 +42,7 @@ Two approaches exist for creating access tokens, but `Fine-grained personal acce
When creating a PAT (Personal Access Token), you need to give it the following permission:
`repository permissions > Issues > Read and write`

<img width="630" alt="SCR-20230527-ogal-2" src="https://github.com/HTsuruo/firebase-extensions/assets/12729025/719bcfd8-12c7-4336-adde-924738553592">
<img width="630" alt="SCR-20230527-ogal-2" src="https://github.com/htsuruo/firebase-extensions/assets/12729025/719bcfd8-12c7-4336-adde-924738553592">

## Billing

Expand Down
4 changes: 2 additions & 2 deletions trigger-github-issues-from-crashlytics/extension.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ icon: icon.png
tags: [utilities]

license: Apache-2.0
sourceUrl: https://github.com/HTsuruo/firebase-extensions
sourceUrl: https://github.com/htsuruo/firebase-extensions

billingRequired: true

author:
authorName: Hideki TSURUOKA
email: tsuru.dev@gmail.com
url: https://github.com/HTsuruo
url: https://github.com/htsuruo

apis:
- apiName: eventarc.googleapis.com
Expand Down

0 comments on commit cc9482b

Please sign in to comment.