Skip to content

Add Deploy to Salesforce button and status badges to README #2

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.

Sign up for GitHub

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

Merged
mshresponse merged 1 commit into from
Jul 10, 2026
Merged

Add Deploy to Salesforce button and status badges to README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# nzc-customreports

[![Validate metadata](https://github.com/mshresponse/nzc-customreports/actions/workflows/validate.yml/badge.svg)](https://github.com/mshresponse/nzc-customreports/actions/workflows/validate.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

A free, unmanaged, open-source package of basic **Lightning Report Types, Reports, and Dashboards** for **Salesforce Net Zero Cloud** (core Lightning analytics only — no CRM Analytics / Einstein components). Metadata API version **60.0**.

## What's included
Expand Down Expand Up @@ -63,10 +66,20 @@ Deploy-time validation against a real Net Zero Cloud org (field and relationship

## Deploy

### Option 1: Deploy button

<a href="https://githubsfdeploy.herokuapp.com?owner=mshresponse&amp;repo=nzc-customreports&amp;ref=main">
<img alt="Deploy to Salesforce" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
</a>

### Option 2: Salesforce CLI

```bash
sf project deploy start --manifest manifest/package.xml --target-org <your-org-alias>
```

Tip: validate first without saving anything to the org by adding `--dry-run`.

## Validating API names against your org

Net Zero Cloud field and child-relationship API names can vary slightly by release and license edition. If a deploy fails on a field or relationship name, verify the exact names in your org and adjust the XML:
Expand Down
Loading